Introduction

The OdinRoom component is the main entry point for the ODIN Unity SDK.

Properties

Property	Description
Gateway	The base URL of the gateway. If you are using our hosted solution, leave it as is, otherwise if you are hosting yourself you need to adjust the URL
Token	For testing purposes you can set a token which should be used when joining the room - you typically do that in code - this is typically used for debugging purposes
Audio Mixer Group	Set a mixer group for audio effects that are automatically added to each voice chat audio source added to the scene
OnRoomJoined	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnRoomJoined event
OnMediaAdded	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnMediaAdded event
OnMediaRemoved	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnMediaRemoved event
OnPeerJoined	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnPeerJoined event
OnPeerLeft	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnPeerLeft event
OnMessageReceived	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnMessageReceived event
OnConnectionStateChanged	A Unity event that you can subscribe to in one of your components to handle the OdinRoom.OnConnectionStateChanged event

The component already handles these events for you per default to implement basic 2D non-spatial voice-chat:

OdinRoom.OnPeerJoined
OdinRoom.OnPeerLeft
OdinRoom.OnMediaAdded
OdinRoom.OnMediaRemoved
OdinRoom.OnConnectionStateChanged

Depending on what you want to do with the audio sources you can subscribe to one of these events in addition to the default handler or you might need to drop the default handler and implement your own.

OdinMicrophoneReader

The OdinMicrophoneReader component is responsible for capturing the audio from the microphone and sending it to the ODIN servers.

Properties

Property	Description
Redirect Captured Audio	If enabled (default) automatically sends captured audio to ODIN servers. Disabling requires special handling and should only be done in rare situations
Silence Captured Audio	Mute audio so that no audio is sent to ODIN servers. This is disabled by default.
Continue Recording	Once the available audio buffer is full OdinMicrophoneReader automatically wraps to start and overwrites previous audio. Should only be disabled in rare use cases
Custom Input Device	OdinMicrophoneReader uses the input device selected in the operation system settings. Enabling this option will allow you to set a specific `Input Device`
Input Device	Set the name of an input device that should be used instead of the default input device set in the operating system. You need to enable `Custom Input Device` to make use of this setting
Autostart Listen	Automatically start listening on the microphone (will activate the microphone in `Start`)
Custom Mic Volume Scale	Disabled by default, enable to set the volume scale in `Mic Volume Scale` setting
Mic Volume Scale	Set a microphone volume scale factor (requires `Custom Mic Volume Scale` to be enabled)
OnAudioData	A Unity event that you can subscribe to in one of your components to handle the MicrophoneReader.OnAudioData event, which is called whenever new audio data is available.

Joining a room

Once you have added the prefab and configured your events, not much happens yet. You need to join a room to start with the voice chat.

Every user connected to the same room can hear and talk to each other user joined in the same room. The room is identified with a basic string identifier. You can join as many rooms as you want, but you can only talk to users in the same room.

To join a room, you just need to set the OdinRoom.Token property. OdinRoom will check each Update cycle if the token has been set and if it has been set, it will join the room.

Warning

Tokens are typically generated by your backend and are used to authenticate the user and to provide the user with the necessary information to join the room. You should never generate tokens in your frontend or client application as this would expose your secret keys to the public. See Access Keys in ODIN for more information on that topic. We have an example on how to generate tokens using a simple NodeJS script in a cloud function: Generating Tokens.

Creating a token for testing purposes

If you want to test ODIN without setting up your own backend, you can use this code to create a token for testing purposes. Please note: The function ( OdinRoom.GenerateTestToken ) is only available in the Unity Editor and should not be used in a production environment.

  var accessKey = "__YOUR_ACCESS_KEY__";
  var roomName = "MyRoom";
  var username = "Username";
  _Room.Token = OdinRoom.GenerateTestToken(roomName, username, 5, AccessKey);

You can create an access key for testing purposes for up to 25 users directly in this web component:

Testing the setup

Just press Play in the Unity Editor to test your basic ODIN integration. The operating system will ask you for permission to use the microphone. You need to build the client and deploy it to a colleague or another machine to test the voice chat integration.

You can also use our free Web Client to test your setup. You’ll just open our Web Client in your browser, set the same access key and room name and you can talk to your Unity client. You can find a guide on how to use the Web Client here.

You should now have simple one-room non-spatial voice chat working. Anyone in the same room can hear and talk to each other. During play and when others are connecting to the same room, you’ll see new GameObjects being created in the hierarchy for peers (they have an OdinPeer component attached to them) and for each peer you’ll see GameObjects with an OdinMedia component being attached.

Warning

Please note: The OdinPeer and OdinMedia GameObjects are created and destroyed by the OdinRoom component. You should not add them manually to your scene or modify them in any way. The components are there to help you understand what is happening in the background.

Implementing 3D spatial voice-chat

Implementing a 3D spatial voice-chat requires a bit more work. It’s basically the same as the 2D non-spatial voice-chat, but, these two things need to be done:

First, the spatialBlend of the AudioSource needs to be set to 1.0 which is 3D sound. This enables Unity to calculate the volume and direction of the sound based on the position of the GameObject in the scene.
Second, the OdinPeer component (and thus subsequent OdinMedia objects) needs to be attached to a GameObject that is moving in the scene. This is typically the GameObject that represents the player or the avatar of the player.

The actual implementation is different for each game or application and depends on how you have set up your multiplayer framework. Typical multiplayer frameworks like Mirror Networking, Unity Netcode for GameObjects or Photon PUN assign connectionIds to players. You can use these connectionIds to identify the player and attach the OdinPeer component to the GameObject that represents the player.

Odin has their own ids for peers and media, so to some extend you need to map ODINs user ids to (connection) ids in your game. When connecting to a room in ODIN, you can set a user data object that will be sent to all other peers in the room. This user data object can contain the connection id of the player in your game. You can then use this connection id to map the Odin user id to the player in your game.

That’s all there is to do to change 2d non-spatial voice-chat to 3D spatial voice-chat.

Tip

We have a guide on how to implement 3D spatial voice-chat using the Mirror Networking framework with the 1.x version of the Unity SDK, but the principles are the same and can be applied to any multiplayer framework. You can find the guide here: Unity Mirror Integration.

Mixing 2D and 3D voice-chat

In some games or applications, you might want to mix 2D non-spatial voice-chat with 3D spatial voice-chat. As use-case for this is that you have 3D spatial voice-chat for players in a “world” room where every player can hear and talk to each other based on their position in the world, but you could also have a radio room for seperate teams that have 2D non-spatial voice-chat.

Imagine CounterStrike where you have 3D spatial voice-chat for the players in the world, but you also have 2D non-spatial voice-chat for the players in the same team. If a player is talking via radio, only the players in the same team he still can be heared by the enemy in 3D spatial voice-chat. So, it might be a good strategy to quickly sneak up to the enemy and listen to what they try to privately discuss in their radio.

To do that, you create two OdinRoom GameObjects in your scene but with different room names. Depending on the room you would have different event handlers to handle 2D voice chat or 3D voice chat.

Next steps

You should now have a basic understanding of how to use the high-level API of the ODIN Unity SDK. You can now start implementing your own voice chat solution in your game or application. Check out the scripting API for more information on the actual functionality.

`}),e.add({id:2,href:"https://www.4players.io/odin/sdk/unity/2.0.0/manual/room/",title:"Low Level API",section:"ODIN Documentation",description:"Low Level API for Unity Components and ODIN integration in Unity Editor",content:`

The ODIN Unity SDK provides a low-level API that allows you to create your own voice-chat experience from scratch.

Tip

This manual handles the low-level API and the classes that are provided with the SDK. If you are looking for easy to use prefabs and components that are provided with the SDK, please refer to the High Level API.

Getting Started

The low-level API is designed to give you full control over the voice-chat experience in your game. It is a set of classes that you can use to create your own voice-chat experience from scratch. All starts with the Room class.

Please see the Sample InstanceSampleBasic that is provided with the SDK to see how to use the low-level API. Please note: The sample code below only shows the most important parts of the sample. It skips error handling and validation for the sake of simplicity. Please refer to the sample code for a complete example.

Creating a Room

The Room class is the main class that you will use to create a voice-chat experience in your game. You first create a local Room object and then join it. The server will create the room object on the fly so you don’t need to to do any bookkeeping of the server-side on your own.

// Create a room instance and provide a gateway or server URL, a sample rate and a flag if the room is stereo or not
_Room = Room.Create(Gateway, 48000, false);

Handling Events

Next step is to handle events that are fired by the room. The room will fire events for all important actions that are happening in the room. You can subscribe to these events and handle them in your game.

_Room.OnRoomJoined += Example_OnRoomJoined;
_Room.OnMediaStarted += Example_OnMediaStarted;
_Room.OnMediaStopped += Example_OnMediaStopped;
_Room.OnMessageReceived += Example_OnMessageLog;

Warning

The events are being called in a different thread that the main thread! You need to make sure that you handle the events in a thread-safe way and you need to make sure that any call into the Unity API is dispatched to the main thread.

If you need to call the Unity API, you need to dispatch the call to the main thread. You can create a ConcurrentQueue instance in your class and dispatch the call to the main thread in the Update method of your MonoBehaviour. There are many examples on how to handle these situations in the Unity community. But here is a quick example:

public static readonly ConcurrentQueue<Action> UnityQueue = new ConcurrentQueue<Action>();

private void Example_OnRoomJoined(object sender, ulong ownPeerId, string name, byte[] roomUserData, ushort[] mediaIds, ReadOnlyCollection<PeerRpc> peers)
{
    // Handle the event
    // ...
    
    // If you need to call into the Unity API, you need to dispatch the call to the main thread
    UnityQueue.Enqueue(() =>
    {
        // Call into the Unity API
        // ...
    });   
}

private void Update()
{
    if (UnityQueue.IsEmpty == false)
        while (UnityQueue.TryDequeue(out var action))
            action?.Invoke();
}

Joining a Room

Once you have created the room and subscribed to the events, you can join the room. You just need to create a token and join the room with it.

To join a room, you just need to set the Room.Token property. Room will check if the token has been set and if it has been set, it will join the room.

Warning

  var accessKey = "__YOUR_ACCESS_KEY__";
  var roomName = "MyRoom";
  var username = "Username";
  _Room.Token = OdinRoom.GenerateTestToken(roomName, username, 5, AccessKey);

You can create an access key for testing purposes for up to 25 users directly in this web component:

Adding Media

Once you have joined the room, you can add media to the room, i.e. add the users microphone stream to the room. If you want users to be connected to each other immediately, you can add the media right after joining the room.

    private void Example_OnRoomJoined(object sender, ulong ownPeerId, string name, byte[] roomUserData, ushort[] mediaIds, ReadOnlyCollection<PeerRpc> peers)
    {        
        // each room has a limited number of ids reserved for encoders i.e audio input / capture
        if (_Room.AvailableEncoderIds.TryDequeue(out ushort mediaId))
            CreateCapture(mediaId);
        else
            Debug.LogError($"Can not create encoder without a encoder id that is free to use");
    }
    
    // Create a media instance and provide a sample rate and a flag if the media is stereo or not
    public void CreateCapture(ushort mediaId)
    {
        if( _Room == null) return;

        // create a encoder where to send audio data to
        if (_Room.GetOrCreateEncoder(mediaId, out MediaEncoder encoder))
        {
            // created encoders have to be started with a customizable rpc call
            _Room.StartMedia(encoder);
            // set a callback for the MicrophoneReader and add sample effects to the pipeline
            LinkEncoderToMicrophone(encoder);
        }
    }
    
    // Find the microphone reader in the scene and link them to the input of the encoder
    private void LinkEncoderToMicrophone(MediaEncoder encoder)
    {
        UnityQueue.Enqueue(() =>
        {
            // this sample does not set PersistentListener direct or by prefab
            if (_AudioInput && _AudioInput.OnAudioData?.GetPersistentEventCount() <= 0 && _Room != null)
                _AudioInput.OnAudioData.AddListener(ProxyAudio);

            OdinMicrophoneReader microphone = GetComponent<OdinMicrophoneReader>();
            if (microphone != null)
            {
                // optionally add effects to the encoder (Input/Capture)

                // add voice activity detection
                OdinVadComponent vadComponent = microphone.gameObject.AddComponent<OdinVadComponent>();
                vadComponent.Media = encoder;
                // add a microphone boost
                OdinVolumeBoostComponent volumeBoostComponent = microphone.gameObject.AddComponent<OdinVolumeBoostComponent>();
                volumeBoostComponent.Media = encoder;
            }
        });
    }

You’ll need to have a OdinMicrophoneReader component attached to your scripted game object for this to work.

It is important to understand what happens here: Imagine the ODIN as an audio pipeline. The microphone has some output and we need to connect that output to the input of the room. With this code, we do exactly that. We link the output of the microphone to the input of the room. The room will then send the audio data to the server and the server will send the audio data to all other peers in the room.

// Link OdinMicrophoneReader output (OnAudioData) to the input of the room (ProxyAudio)
_AudioInput.OnAudioData.AddListener(ProxyAudio);

Creating a Playback Stream

Now, all users in the room can hear you, but you can’t hear them yet. To hear them, you need to create a playback stream for each media created by every user/peer in the room. You can do this by subscribing to the Room.OnMediaStarted .

    private void Example_OnMediaStarted(object sender, ulong peerId, MediaRpc media)
    {       
        // in default setup the room creates decoders intern automatically on the event
        // get the decoder corresponding to a peer
        if (_Room.RemotePeers.TryGetValue(peerId, out PeerEntity peer))
            if (peer.Medias.TryGetValue(media.Id, out MediaDecoder decoder))
                CreatePlayback(decoder, peer);
    }
    
    public void CreatePlayback(MediaDecoder decoder, PeerEntity peer)
    {
        // EXAMPLE optionally add INTERNAL effects to the decoder (Output/Playback)
        MediaPipeline pipeline = decoder.GetPipeline();
        if (pipeline.AddVadEffect(out _))
            Debug.Log($"added {nameof(VadEffect)} to \\"OdinDecoder {decoder.Id}\\" of peer {peer.Id}");

        // Odin uses Unity to play the audio
        DispatchCreateAudioSource(decoder, peer);
    }
    
        /// <summary>
    /// Add OdinMedia that handles <see cref="AudioSource"/> and copy data from Odin to <see cref="AudioClip"/>
    /// </summary>
    /// <remarks>optionally <see cref="MediaDecoder.Pop"/> samples can be used with <see cref="AudioClip.SetData"/></remarks>
    private void DispatchCreateAudioSource(MediaDecoder decoder, PeerEntity peer)
    {
        UnityQueue.Enqueue(() =>
        {
            GameObject container = new GameObject($"OdinDecoder {decoder.Id}");
            container.transform.parent = transform;
            OdinMedia mediaComponent = container.AddComponent<OdinMedia>();
            mediaComponent.MediaDecoder = decoder; // set the decoder to copy data from
            mediaComponent.Parent = peer; // the use of OdinMedia requires a parent else it is optional
            mediaComponent.enabled = true;

            // optionally add interal effects wrapped with Unity to the decoder (Output/Playback)
            // for audio pipeline manipulation

            // add a playback volume boost
            OdinVolumeBoostComponent volumeBoostComponent = container.AddComponent<OdinVolumeBoostComponent>();
            volumeBoostComponent.Media = mediaComponent;
            // add a playback mute 
            OdinMuteAudioComponent muteComponent = container.AddComponent<OdinMuteAudioComponent>();
            muteComponent.Media = mediaComponent;
            // see other Effects or build one
            // with CustomEffect (PipelineEffect)
            // or with Unity helper class OdinCustomEffectUnityComponentBase
        });
    }

Of course, you also need to handle the case if users disconnect or remove their medias from the room (i.e. muting themselves). You can do this by subscribing to the Room.OnMediaStopped .

    private void Example_OnMediaStopped(object sender, ulong peerId, ushort mediaId)
    {
        Debug.Log($"Peer {peerId} removed media {mediaId}");

        DispatchDestroyAudioSource($"OdinDecoder {mediaId}");
    }
    
    /// <summary>
    /// Disposing objects is necessary to prevent memory leaks
    /// </summary>
    private void DispatchDestroyAudioSource(string gameObjectName)
    {
        UnityQueue.Enqueue(() =>
        {
            OdinMedia mediaComponent = this.gameObject
                .GetComponentsInChildren<OdinMedia>()
                .FirstOrDefault(component => component.name == gameObjectName);

            if (mediaComponent != null)
                Destroy(mediaComponent.gameObject);
        });
    }

Testing the setup

Implementing 3D spatial voice-chat

Implementing a 3D spatial voice-chat requires a bit more work. It’s basically the same as the 2D non-spatial voice-chat, but, these two things need to be done:

First, the spatialBlend of the AudioSource needs to be set to 1.0 which is 3D sound. This enables Unity to calculate the volume and direction of the sound based on the position of the GameObject in the scene.
Second, the OdinPeer component (and thus subsequent OdinMedia objects) needs to be attached to a GameObject that is moving in the scene. This is typically the GameObject that represents the player or the avatar of the player.

That’s all there is to do to change 2d non-spatial voice-chat to 3D spatial voice-chat.

Tip

Mixing 2D and 3D voice-chat

To do that, you create two Room instances in your scene but with different room names. Depending on the room you would have different event handlers to handle 2D voice chat or 3D voice chat.

Next steps

`}),e.add({id:3,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/odinbanner/",title:"Odin Banner",section:"ODIN Documentation",description:"A simple editor component that display a nice image in the Unity inspector",content:`

This is a simple, non-functional but cool looking editor component that shows a 4Players ODIN Banner in the inspector.

It also shows two buttons that allow you to quickly get to the Admin Panel and this developer documentation.

`}),e.add({id:4,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/odinbanner/",title:"Odin Banner",section:"ODIN Documentation",description:"A simple editor component that display a nice image in the Unity inspector",content:`

This is a simple, non-functional but cool looking editor component that shows a 4Players ODIN Banner in the inspector.

It also shows two buttons that allow you to quickly get to the Admin Panel and this developer documentation.

`}),e.add({id:5,href:"https://www.4players.io/odin/sdk/unity/manual/odinbanner/",title:"Odin Banner",section:"ODIN Documentation",description:"A simple editor component that display a nice image in the Unity inspector",content:`

This is a simple, non-functional but cool looking editor component that shows a 4Players ODIN Banner in the inspector.

It also shows two buttons that allow you to quickly get to the Admin Panel and this developer documentation.

`}),e.add({id:6,href:"https://www.4players.io/odin/sdk/unreal/manual/",title:"Unreal Engine Plugin Manual",section:"ODIN Documentation",description:"Manual describing the Unreal Engine Plugin",content:`

The Unreal Engine plugin comes with full blueprint support to make it as easy as possible to use ODIN in your game. Please make sure to have a basic understanding of how ODIN works as this helps a lot understanding the next steps.

Info

This manual highlights the key steps to take to get started with ODIN. For a more detailed implementation please refer to our Unreal Sample project. Select the blueprints in the Unreal Sample Project, Copy them and Paste them in your own project to get started quickly!

Download Unreal Sample Project

Basic Process

If you have read the introduction you have learned that every user connected to the same ODIN room (given by a string of your choice) will be able to exchange data and voice. An ODIN room is automatically created by the ODIN server when the first user joins and is automatically removed once the last user leaves.

To join a room an access token needs to be created. An access token gives access to an ODIN room and can be created within the client. For testing and development purposes that’s fine. In production you should create an access token on server side. We’ll provide various packages for JavaScript (npm) or PHP (Composer) to create access tokens and we also have a complete server ready to go that you can deploy as a cloud function to AWS or Google Cloud.

After the room has been joined, data can be exchanged, i.e. text chat messages or other real-time data. If your user should be able to talk to others, a microphone stream (a so called media) has to be added to the room. Now, every user can talk to every other user in that room. More advanced techniques include 3D audio that allows you to update your position every couple of seconds to the server which then makes sure, that only users nearby hear your voice to reduce traffic bandwidth and CPU usage. But more on that later.

So, to summarize, the basic process is:

Get an access key
Create an access token with the access key for a specific room id (just a string identifying the room)
Join the room with the access token
Add a media stream to connect the microphone to the room

Implementing with Blueprint

Let’s get started adding ODIN to an existing (or new) Unreal Engine Project. You’ll find all Blueprint nodes in the root folder Odin.

This is the full blueprint that we are about to create:

You can create the blueprint anywhere in your project - but it makes most sense on your Default Player Character Class - since this is where your Odin Synth Components will live. Just make sure that you have it in a class that exists on each client (for example the Game Mode only exists on the server and therefore is not eligible for this logic).

Creating an access key

First, you need to create an access key. As the access key is used to authenticate your requests to the server and also includes information about your tier, e.g. how many users are able to join the same room and a few other settings. You can create a free access key for up to 25 users right here. If you need more or want to go into production, you need to sign up with one of our tiers. See pricing for more information.

More information about access keys can be found in our Understanding Access Keys guide.

For now, you can use this widget to create a demo access key suitable for up to 25 concurrent users:

Press the Create Access Key button and write the access key down somewhere. We’ll need this access key a bit later down the road.

Creating an access token

Add a Generate Room Token node to your Blueprint Canvas. Now, drag out from the left Target and choose Construct a Token Generator from the list. This will add the node to your canvas and connect both. Please note: In production you would load the token from your cloud function (see above) but for now we just generate a random access token directly in the game.

Now, drag out from “Room Id” and choose Promote to Variable to create a variable for the name of the Room. You’ll need to compile your Blueprint and then enter Lobby as the default value for the room name or anything else that makes sense to you.

Next, drag out from Access Key of your Construct a Token Generator node and choose Promote to Variable. This variable will hold our access key. Compile again and set the default value to the access key you created above.

Last but not least create an Event Begin Play node and connect it to the Generate Room Token node. In most use cases you might not want players to be able to talk to everyone else right from the start. Choose another event in this case. But for testing purposes this should be fine.

Your blueprint should look like this now.

Configure the room access

ODIN supports various settings when joining a room (APM settings). Here you can set features like “Voice Activity Detection” and many other features.

Create a new Construct local room handle node and drag out from Initial APM Settings. Choose Make Odin APM Settings from the list. This will add the node to your canvas and connect both.

You can play around with APM settings to work out good values for your type of game.

It should look like this:

Info

The best way to get a clean blueprint is to set the output of the Construct local room handle node to a variable. Everywhere in the Blueprint you can now access the Room with a Get Room node.

Event Flow

Once you are connected to the ODIN server, a couple of events will be fired that allow you to setup your scene and connecting audio output to your player objects in the scene.

Have a look at this application flow of a very basic lobby application. Events that you need to implement are highlighted in red.

1	Join Room	The user navigates to the multiplayer lobby. Here, all players currently playing the game are connected to the same ODIN room so that they can figure out what to play. The application uses Join Room to join the room. Please note: The server automatically creates the room if it does not exist. There is no need for bookkeeping on your side.
2	Room Joined	The On Room Joined event is triggered that allows you to handle logic on the joining client before the user actually joins the room. Please note: After that `Room Joined` event you’ll receive `PeerJoined` and `MediaAdded` events for each user that is already connected to the room. So you can use the same code/blueprint for users that are already connected or will later connect to the room.
3	Peer Joined	For each user connected to the same ODIN room you’ll receive an On Peer Joined event that allows you to handle logic once a peer joined the room. This event contains user data that they sent when they have joined the room and is typically used to relfect any meta data of the user in your client application.
4	Media Added	For each user connected to the same ODIN room which has a microphone stream enabled (some of them might only be spectators just listening) an On Media Added event is triggered. This event needs to be handled by your application. In this callback, you need to assign the media object via the Odin Assign Synth to Media function to an `Odin Synth Component`.
6	Media Removed	Whenever a user disconnects from the room, or closes their microhone stream an On Media Removed event is triggered. You are responsible for cleaning up the synth components that you have created earlier in the `Media Added` callback function using the `Remove Media` function.
7	Peer Left	Whenever a user disconnects a room, this event is triggered. For example, you can show a push notification that a player has left the room. More info here: On Peer Left . Important notice:. Whenever a peer leaves a room, the media gets removed as well. So, aligned with this event, for each media of this peer, an On Media Removed event will be triggered as well.

Adding a Peer Joined Event

To create event handling, create a new delegate Bind to On Peer Joined node.

Warning

Unreal does not list the Bind to On Peer Joined option without dragging off of an Odin Room variable. If you want to have that option shown in any case, disable the Context Sensitive checkbox on the top right corner. Then you should find the event in the Odin/Events folder.

You’ll need to connect the Room object reference that you created earlier with the Construct local room handle node. This way, you can easily handle events differently for different rooms you connect. You can even connect multiple rooms at the same time, but handle them differently in your code.

Now, that you have created that node, drag out from the Events slot until you see a red line. Next, release the mouse cursor and Unreal will automatically create the correct event node which will handle this event.

Don’t forget to connect the Exec slot with the process flow of your application. You should always setup event handling before joining a room.

The On Media Added Event

The On Media Added event is triggered whenever a user connected to the room activates their microphone, or directly after joining a room you’ll get these events for all active users in that room.

You’ll get a Media object that represents the microphone input for the peer (i.e. connected user) that this media belongs to. The Media object is a real-time representation which is basically just a number of floats that represent the users voice. A node needs to be created that translates that into audio output. This is the Odin Synth Component. You use the Odin Assign Synth to Media node that will connect both and actually activates the audio.

The easiest way is to add the Odin Synth Component to your player asset and place it somewhere near the head. Then, in your blueprint you can use the Get Component By Class node to get the Odin Synth Component from the player actor.

Instead of adding the Odin Synth Component to your player asset, you can also use the Add Odin Synth Component to create the component and attach it to the player actor at runtime.

After wiring everything together, it should look something like that:

That’s it. Now, every user connected to the same room will be heard with full volume where the local player is located.

Info

In a real 3D shooter with 3D audio you would not choose the local player, but map the Odin Peer Id with your Unreal Player Id and then assign the Media to the corresponding player character. This way, Unreal will automatically process the audio in its audio engine and apply attenuation, e.g. dampen the volume the farther away the player is from the listener.

Joining a room

Now, we have everything in place to join a room: We have created an access token with the room id “Lobby” and have configured room settings for our client. Now let’s connect them to join a room.

Add a Join Room node to your Blueprint Canvas.

Connect the Return Value from Construct local room handle with the Room input of the Join Room node. Next, connect the Return Value of your Generate Room Token node to the Token input of the Join Room node. Next, we need to configure our gateway: Drag out from URL of the Join Room node and choose Promote to Variable. This variable will hold the gateway. Compile the Blueprint and set https://gateway.odin.4players.io as the default value. This is our public gateway. You can also launch your own gateway for maximum privacy, but to get started, our public one is a good option.

As shown in the image above, you can also drag out event handling to get notifications if something went wrong. We just added simple output to the Log to see what happens.

Last but not least, you need to connect the Generate Room Token process flow output to the input of your Join Room node.

Adding a media stream

Now that we have joined a room, we need to add our microphone (at least if users should be able to talk) to the room so everyone else in the room hears what we are saying. To do that, we create a Create Audio Capture node and connect it with a new media constructed with Construct Local Media . Then we connect both with an Add Media To Room node as shown in the image below. Since you need to start capturing from the audio device, we save the Audio Capture object in a variable and use that later to activate the microphone. By stopping the audio capture you can implement mute very easily later or something like push to talk.

You can create event handling for errors as shown before. The process is basically always the same. Odin delivers an error code, and you can use the Format Error node to create an error message that you can place in a log or somewhere else.

Info

If you don’t find the Create Audio Capture and Start Audio Capturenode, please make sure you have the Audio Capture Plugin enabled which is part of the default Unreal installation. See FAQ for a more detailed description on how to resolve that issue.

Warning

Make sure to only execute the Start Audio Capture node after successfully constructing audio capture with Create Audio Capture, constructing the media with Create Media, and finally adding it to the room with Add Media to Room.

Testing with ODIN client

As ODIN is working cross platform, you can use our ODIN client app to connect users to your Unreal based game. There are numerous use cases where this is a great option (see Use Cases Guide) but its also great for development.

Fire up your browser and load our ODIN client: https://app.odin.4players.io/. We need to configure that client to use the same access key that we use within Unreal. Click on the Gear icon next to the Connect button. You should see something like this:

Info

If you don’t see the Your Access Key option at the end of the dialog, you need to scroll down a bit.

Enter your access key that you have created earlier and that you have set in the Access Key variable exposed in the Blueprint and click on Save. Now, the ODIN client will use the same access key as your Unreal based game, connecting both platforms together.

In the connection dialog, set the same room name as you did in Unreal (i.e. Lobby), make sure the same gateway is set as in Unreal (i.e. https://gateway.odin.4players.io) and enter a name. Then click on Connect.

You should see something like this:

Now, get back to Unreal and press Play in the editor. Unreal will fire up your game and will join the same room as you have in your browser. You should here a nice sound indicating that another user has joined the room. Navigate to your browse, and now you should see another entry in the users list: “Unknown”. If you talk, you should here yourself.

Ask a colleague or fried to setup the ODIN client with your access key and the same room and you’ll be able to chat together, one inside your game and the other one in their browser. This is a great way of quickly testing if everything works fine and we do that internally at 4Players very often.

Enabling 3D Audio

So far we have enabled the voice chat in your application, but most likely you want to use the 3D Audio Engine of Unreal. This for itself might be a trivial step since you can simply assign proper Attenuation Settings to your Odin Synth Component. But you also need to consider another problem: the positioning of the Odin Synth Components in your scene.

The simplest solution is to attach the Odin Synth Components to the Pawns representing the respective players, but you somehow need to keep track which Odin Peer is associated with which player - so let’s have a look at how to do that.

The implementation in detail depends on your networking and replication system of course, but most of the time you will want to use the native Unreal Engine Networking, so we will assume that you use that. If you use another system you will need to adjust the steps accordingly.

Propagating an Identifier

In order to assign the correct Odin Synth Component to the according Player Controlled Character we will need to do keep track of a unique identifier for each player, their actors and their Odin Peer Ids.

If you have not done that earlier, now is the time to move the logic to your Player Character blueprint or at least a component living there. For this sample we will assume you have created the Odin logic directly on the Player Character class.

With this out of the way we can start. First we need to propagate an identifier of the player for your game session. You can use GUIDs, or your Unique Player Identifiers that you already have due to a login process or something similar. You can set the ID in any event that is called during startup, a good entry point is the Event Possessedof the Character Class - here you can simply check if you are running on the Server and then you set a variable that is replicated across all Clients.

With this done you can continue and use that variable to identify a player on the join call to the Odin room - so from here we can call that routine we already have created earlier in this tutorial.

The variable Player Id’s replication mode is set to RepNotify. So when the variable is set we can add some extra logic to each of the clients receiving the replication notification. Find the OnRepPlayerIdfunction in your character blueprint and here we will add some additional logic.

To your Default Game Instance blueprint add a variable named PlayerCharacters and first make it a GUIDtype - then in its details click the icon (looking somewhat like a pill) next to the variable type and select Map from the drop down menu. Now you can change the second type of the variable to your Default Player Character class. This map will help us keep track of the actors and is able to return an actor when we have an identifier - we will need that later, when we want to add Odin Synth Components to the correct Player Character objects.

So in the OnRepPlayerId function we will now add a new Key Value pair to that new map on the Game Instance - in order to do that we will need to cast the game’s Game Instance accordingly and then add a new element to the Player Characters map. You can see the finished function in the image some paragraphs below.

Joining a Room with the Identifier

To make sure that we already have the identifier on the owning client while joining the Odin room we can call the custom event Join Odin Roomfrom the OnRepPlayerIdfunction as well. If we do this on the Possessed event of the character, we cannot guarantee that the local player id was already set.

This Event will now be connected to our routine that creates an access token and connects to an Odin Room - earlier it was connected to the Begin Playevent of our local player. So in the OnRepPlayerId we will just check if we are on the locally controlling client and then we will call a new custom event.

The new Join Odin Room event is now connected to our nodes that generate an access token.

The start of the Join Odin Room custom event

Next we need to pass the identifier to the Join Roomcall as custom user data so that all other Odin clients can associate that identifier with our Odin id. You can use the methods to create a User Data Byte Array for that. First call Construct Json Object and then Set String Field on it and write the GUID to it as a string. Now you can Encode As Bytesthe json object and send it with the join room call.

Handling the Peer Joined Event with an Identifier

Now each other client will receive an event once a player has joined the Odin Room. Here we can extract the given player identifier from the user data. The next problem we will handle here is that once we get the Odin Media object we do not get the user data in the same event, so we need to also map the Odin Peer Id to our Player Characters. To do that now add another map to the Game Instance and this time make it an Integer64 and Player Character map. Now you can find the correct player character and add it to the new map using the passed Peer Id. This is what the finished function will look like:

Handling the Media Added Event with an Identifier

Now we can finally add the Odin Synth Component to the correct player character. Find your event or function that handles the Media Added event and now instead of simply adding an Odin Synth Component to the local player character we can now actually find the correct character and attach the synth component there.

Use the passed Peer Id to get the correct player character from the Game Instance’s Odin Player Character map and assign the Odin Synth Component there now:

Conclusion

This is all you need to do for now to add the Odin Synth Components to the correct player characters. Now you can change the attenuation settings to whatever you need for your voice chat to work in your 3D world - from what we have now it is the most straight forward to simply drag off of the Create Odin Synth Component node and call the Set Attenuation Settings node and assign it a new Attenuation Settings asset that you can create in the Content Browser like any other asset before.

Odin is agnostic of the audio engine, so you can really just use any engine you like, be it the native Unreal Audio Engine, or a 3rd Party Engine, like Steam Audio, Microsoft Audio, FMOD and so on. It is all possible simply by changing the project settings and the attenuation settings of the Odin Synth Component accordingly.

`}),e.add({id:8,href:"https://www.4players.io/odin/ai-training/unity/sdk-reference/",title:"ODIN Unity SDK Reference",section:"ODIN Documentation",description:"A complete reference of all the ODIN types available in the Unity SDK with deep links to the documentation.",content:`

This document provides links to all the ODIN types available in the Unity SDK.

Classes

OdinHandler Class

Definition

Name: OdinHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinhandler

public class OdinHandler : MonoBehaviour

The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes.

Properties

Name	Description
public static OdinEditorConfig Config { get; }	Static reference to the global Unity
public static OdinHandler Instance { get; }	Singleton reference to this OdinHandler
public bool HasConnections { get; }	True if any Room is joined
public MicrophoneReader Microphone	Unity Component that handles one Microphone where data gets routed through (n) Media
public RoomCollection Rooms { get; }
public RoomJoinProxy OnRoomJoin	Called before an actual room join
public RoomJoinedProxy OnRoomJoined	Called after a room is joined successfully
public RoomLeaveProxy OnRoomLeave	Called before a room leave
public RoomLeftProxy OnRoomLeft	Called after a room is destroyed
public PeerJoinedProxy OnPeerJoined	Called on every Peer that joins the room(s) we're connected to
public PeerUserDataChangedProxy OnPeerUserDataChanged	Called on every Peer that updates his UserData in the same room(s)
public PeerLeftProxy OnPeerLeft	Called on every Peer that left in the same room(s)
public MediaAddedProxy OnMediaAdded	Called on every Peer that created a media in the same room(s)
public MediaRemovedProxy OnMediaRemoved	Called on every Peer that closed/destroyed one of his own media in the same room(s)
public MediaActiveStateChangedProxy OnMediaActiveStateChanged	Called on every activity change of a media in the same room(s)
public RoomUserDataChangedProxy OnRoomUserDataChanged	Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.
public MessageReceivedProxy OnMessageReceived	Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem
public ConnectionStateChangedProxy OnConnectionStateChanged	Called on the Room that changed the connection state
public UnityCreatedMediaObject OnCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
public UnityDeleteMediaObject OnDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
public readonly string UnityAudioSourceTag	Identify by Unity-Tag to attach a Audio
public bool Use3DAudio	Enable 3D Audio via preset Odin
public bool CreatePlayback	Creates Room_OnMediaAdded(System events
public AudioMixer PlaybackAudioMixer
public AudioMixerGroup PlaybackAudioMixerGroup

Methods

Name	Description
public IUserData GetUserData()
public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)	Join or create a room by name and attach a Media
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)	Join or create a room by name and attach a Media
public async void LeaveRoom(string roomName)	Leave and free the Room by name
public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)	Returns the attached Audio
public void RoomsSetPositionScale(float scale)	Configures the allowed 'view' distance for proximity calculation of peers in each room
public void RoomsUpdatePosition(float x, float y)	Updates the two-dimensional position of our own peer in each room
public void UpdateUserData(IUserData userData)	Updates the Rooms
public Room GetRoom(string id)	Gets the room object from Odin
public Peer GetPeer(string roomId, ulong peerId)	Gets the a Peer object from a specified room matching a peer ID
public PlaybackStream GetMedia(string roomId, long mediaStreamId)	Get the PlaybackStream of a peer in the room
public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)	Get all remote peers inside a room
public void BroadcastMessage(byte[] data)	Sends arbitrary data to a all remote peers in all rooms
public PlaybackComponent[] GetPlaybackComponents()	Gets all Audio across all rooms
public PlaybackComponent[] GetPlaybackComponents(string roomId)	Gets all Audio across all rooms
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)	Gets all Audio across all rooms
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)	Gets all Audio across all rooms
public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)	Gets a Audio
public void DestroyPlaybackComponents()	Destroys all Audio instances
public void DestroyPlaybackComponents(string roomId)	Destroys all Audio instances
public void DestroyPlaybackComponents(ulong peerId)	Destroys all Audio instances
public void DestroyPlaybackComponents(long mediaStreamId)	Destroys all Audio instances

NativeBindings Class

Definition

Name: NativeBindings
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/nativebindings

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Description
public const string OdinVersion = "1.6.7"	ODIN_VERSION
public const uint BlockSamplerate = 48000U	Block_SAMPLE_RATE

OdinException Class

Definition

Name: OdinException
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinexception

public class OdinException : Exception, ISerializable, _Exception

Exception type for the native ODIN runtime

Properties

Name	Description
public uint ErrorCode	OdinErrorCode

OdinLibrary Class

Definition

Name: OdinLibrary
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinlibrary

public static class OdinLibrary

Main lib entry class

Properties

Name	Description
public static bool IsInitialized { get; }	Indicates whether or not the native ODIN runtime has been loaded and initialized
public static string NativeBinary { get; }	Location of the native ODIN runtime binary
public static SupportedPlatform Platform { get; }	Platform the library is running on

Methods

Name	Description
public static void Initialize()	Initializes the native ODIN runtime
public static void Initialize(OdinLibraryParameters parameters)	Initializes the native ODIN runtime
public static void Release()	Releases the unmanaged resources used by the Core-Instance

OdinLibraryParameters Class

Definition

Name: OdinLibraryParameters
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Properties

Name	Description
public string[] PossibleNativeBinaryLocations { get; set; }	Possible install location of the native ODIN runtime binary
public SupportedPlatform Platform { get; set; }	Determines which platform specific code needs to be executed

Methods

Name	Description
public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)	Returns the name of the native ODIN runtime binary that fits the current environment

OdinMediaConfig Class

Definition

Name: OdinMediaConfig
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig

public class OdinMediaConfig

ODIN audio stream configuration

Properties

Name	Description
public MediaSampleRate SampleRate { get; set; }	The number audio samples carried per second in Hz
public MediaChannels Channels { get; set; }	The number of audio channels

Methods

Name	Description
public override string ToString()	Debug

OdinRoomConfig Class

Definition

Name: OdinRoomConfig
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinroomconfig

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Properties

Name	Description
public bool VoiceActivityDetection { get; set; }	Enables or disables voice activity detection (VAD)
public float VoiceActivityDetectionAttackProbability { get; set; }	Voice probability value when the VAD should engage.
public float VoiceActivityDetectionReleaseProbability { get; set; }	Voice probability value when the VAD should disengage after previously being engaged.
public bool VolumeGate { get; set; }	Enables or disables volume gate
public float VolumeGateAttackLoudness { get; set; }	Root mean square power (dBFS) when the volume gate should engage.
public float VolumeGateReleaseLoudness { get; set; }	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
public bool EchoCanceller { get; set; }	Enable or disable echo cancellation
public bool HighPassFilter { get; set; }	Enable or disable high pass filtering
public bool PreAmplifier { get; set; }	Enable or disable the pre amplifier
public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }	Set the aggressiveness of the suppression
public bool TransientSuppressor { get; set; }	Enable or disable the transient suppressor
public bool GainController { get; set; }	Enable or disable the gain controller

Methods

Name	Description
public static OdinRoomConfig GetOdinDefault()	Creates Apm OdinRoomConfig based on Odin
public override string ToString()	Debug

Utility Class

Definition

Name: Utility
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/utility

public static class Utility

Properties

Name	Description
public const uint OK = 0U	Representative ErrorCode for Ok.

Methods

Name	Description
public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)	Get sample size by samplerate and time
public static bool IsError(uint error)	Determines if the specified error code identifies an actual error.

MediaCollection Class

Definition

Name: MediaCollection
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediacollection

public class MediaCollection : IReadOnlyCollection&lt;MediaStream&gt;, IEnumerable&lt;MediaStream&gt;, IEnumerable, IEqualityComparer&lt;MediaStream&gt;

Internal collection of available media streams

Properties

Name	Description
public MediaStream this[long key] { get; }	Try to get a media stream by ID
public int Count { get; }	Count of streams in the collection
public bool IsReadOnly { get; }	Indicates whether elements can be added or removed from the collection

Methods

Name	Description
public bool Add(MediaStream item)	Add a stream to the collection
public void Clear()	Free and empty the collection
public bool Contains(long id)	Determines whether the stream by id is in the collection
public bool Contains(MediaStream item)	Determines whether the stream by id is in the collection
public void CopyTo(MediaStream[] array, int arrayIndex)	Copies stream of the collection to an array
public bool Equals(MediaStream x, MediaStream y)	Determines whether the streams are equal
public IEnumerator<MediaStream> GetEnumerator()	Get enumerator for iteration
public int GetHashCode(MediaStream obj)	Default GetHashCode
public bool Remove(long id)	Remove a stream by handle id from the collection
public bool Remove(MediaStream item)	Remove a stream by handle id from the collection
IEnumerator IEnumerable.GetEnumerator()

MediaStream Class

Definition

Name: MediaStream
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediastream

public abstract class MediaStream : IDisposable

Base stream

Properties

Name	Description
public long Id { get; }	Handle ID
public OdinMediaConfig MediaConfig { get; }	Audio config of the media stream
public CancellationTokenSource CancellationSource { get; }	Control of async read and write tasks
public bool IsActive { get; }	Indicates wether or not the media stream is active and sending/receiving data
public bool HasErrors { get; }	Indicates wether or not the last media stream api call result is an error code
public bool IsInvalid { get; }	Indicates wether or not the media stream handle is invalid or closed

Methods

Name	Description
public ushort GetMediaId()	Returns the media stream ID and updates Id.
public ulong GetPeerId()	Returns the ID of the peer that own this media stream.
public virtual void AudioPushData(float[] buffer, int length)	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
public virtual void AudioPushData(float[] buffer)	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
public virtual async void AudioPushDataAsync(float[] buffer)	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
public abstract bool AudioReset()
public virtual uint AudioReadData(float[] buffer)	Reads data from the audio stream.
public virtual uint AudioReadData(float[] buffer, int length)	Reads data from the audio stream.
public virtual bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)	Retrieves statistics for the specified Media.
public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)	Reads data from the audio stream.
public virtual async Task<uint> AudioReadDataAsync(float[] buffer)	Read audio data using a custom custom CancellationSource.
public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)	Set a resampler and resamples a chunk of audio.
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)	Set a resampler and resamples a chunk of audio.
public bool Cancel()	Cancel the custom CancellationSource.
public override string ToString()	Debug
public void Dispose()	On dispose will free the stream and resampler

MicrophoneStream Class

Definition

Name: MicrophoneStream
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/microphonestream

public class MicrophoneStream : MediaStream, IDisposable

Representation of a write only audio stream

Properties

Name	Description
public bool IsMuted { get; }

Methods

Name	Description
public void MuteStream(bool mute)
public override void AudioPushData(float[] buffer, int length)
public override bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)	AudioReadData and AudioReadDataAsync are not supported!
public override bool AudioReset()	AudioReset is not supported!
public override uint AudioReadData(float[] buffer)	AudioReadData is not supported!
public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)	AudioReadDataTask is not supported!
public override Task<uint> AudioReadDataAsync(float[] buffer)	AudioReadDataAsync is not supported!

PlaybackStream Class

Definition

Name: PlaybackStream
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/playbackstream

public class PlaybackStream : MediaStream, IDisposable

Representation of a read only audio stream

Methods

Name	Description
public override void AudioPushData(float[] buffer)	AudioPushDataTask and AudioPushDataAsync are not supported!
public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)	AudioPushDataTask and AudioPushDataAsync are not supported!
public override void AudioPushDataAsync(float[] buffer)	AudioPushDataTask and AudioPushDataAsync are not supported!
public override bool AudioReset()	This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

OdinClient Class

Definition

Name: OdinClient
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinclient

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Properties

Name	Description
public RoomCollection Rooms { get; }	A collection of all Room
public Uri EndPoint { get; }	Connection EndPoint. Default from OdinEditorConfig.
public string AccessKey { get; }	Client AccessKey for all new rooms. Default from OdinHandler config.
public IUserData UserData { get; set; }	Client custom UserData

Methods

Name	Description
public async Task<Room> JoinRoom(string name, string userId)	Join or create a Room by name via a gateway
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)	Join or create a Room by name via a gateway
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)	Join or create a Room by name via a gateway
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)	Join or create a Room by name via a gateway
public async Task<Room> JoinNamedRoom(string roomalias, string token, IUserData userData = null, Action<Room> setup = null)	Join or create a named Room by token via a gateway
public async void UpdateUserData(IUserData userData)	Updates the Rooms for the current peer
public async void SetPositionScale(float scale)	Updates the Rooms
public async void UpdatePosition(float x, float y)	Updates the Rooms
public async Task<bool> LeaveRoom(string name)	Leave a joined Room
public void Close()	Completly closes this Client and all Room associated.
public void Dispose()	On dispose will free all NativeMethods

OdinDefaults Class

Definition

Name: OdinDefaults
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odindefaults

public static class OdinDefaults

ODIN default configuration

Properties

Name	Description
public static bool Verbose	Enable additional logs
public static bool Debug	Enable additional debug logs
public static string AccessKey { get; set; }	Default access key
public static string Server { get; set; }	Default server url
public static string UserDataText { get; set; }	Default text representation of UserData
public static MediaSampleRate DeviceSampleRate { get; set; }	Microphone default Sample-Rate
public static MediaChannels DeviceChannels { get; set; }	Microphone default Channel
public static MediaSampleRate RemoteSampleRate { get; set; }	Playback default Sample-Rate
public static MediaChannels RemoteChannels { get; set; }	Playback default Channel
public static bool PeerJoinedEvent	Idicates whether the event is enabled by default
public static bool PeerLeftEvent	Idicates whether the event is enabled by default
public static bool PeerUpdatedEvent	Idicates whether the event is enabled by default
public static bool MediaAddedEvent	Idicates whether the event is enabled by default
public static bool MediaRemovedEvent	Idicates whether the event is enabled by default
public static bool RoomUpdatedEvent	Idicates whether the event is enabled by default
public static bool MediaActiveStateChangedEvent	Idicates whether the event is enabled by default
public static bool MessageReceivedEvent	Idicates whether the event is enabled by default
public static ulong TokenLifetime { get; set; }	JWT room token lifetime
public static bool VoiceActivityDetection	Idicates whether the ApmConfig setting is enabled by default
public static float VoiceActivityDetectionAttackProbability	Idicates the vad attack probability ApmConfig setting by default
public static float VoiceActivityDetectionReleaseProbability	Idicates the vad release probability ApmConfig setting by default
public static bool VolumeGate	Idicates whether the ApmConfig setting is enabled by default
public static float VolumeGateAttackLoudness	Idicates the gate attack loudness ApmConfig setting by default
public static float VolumeGateReleaseLoudness	Idicates the gate release loudness ApmConfig setting by default
public static bool EchoCanceller	Idicates whether the ApmConfig setting is enabled by default
public static bool HighPassFilter	Idicates whether the ApmConfig setting is enabled by default
public static bool PreAmplifier	Idicates whether the ApmConfig setting is enabled by default
public static NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
public static bool TransientSuppressor	Idicates whether the ApmConfig setting is enabled by default
public static bool GainController	Idicates whether the ApmConfig setting is enabled by default

Peer Class

Definition

Name: Peer
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peer

public class Peer : IDisposable

Client/Remote peer

Properties

Name	Description
public ulong Id { get; }	Peer id
public string RoomName { get; }	Associated room name of this peer
public string UserId { get; }	Peers user id
public UserData UserData { get; }	Peer userdata
public MediaCollection Medias { get; }	Associated medias of this peer

Methods

Name	Description
public void AddMedia(PlaybackStream stream)	Associate a media with the peer
public bool RemoveMedia(long mediaStreamId)	Remove a associated media from the peer
public List<long> GetMediaStreamIds()	Get a copy of all ids of Media from this peer
public override string ToString()	Debug
public void Dispose()	Free peer with all associated medias

PeerCollection Class

Definition

Name: PeerCollection
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peercollection

public class PeerCollection : IReadOnlyCollection&lt;Peer&gt;, IEnumerable&lt;Peer&gt;, IEnumerable, IEqualityComparer&lt;Peer&gt;

Intern peer dictionary

Properties

Name	Description
public Peer this[ulong key] { get; }	Try to get Peer by id
public int Count { get; }	Count of peers in the collection
public bool IsReadOnly { get; }	Indicates whether elements can be added or removed from the collection

Methods

Name	Description
public bool Add(Peer item)	Add a peer to the collection
public void Clear()	Free and empty the collection
public bool Contains(ulong id)	Determines whether the peer by id is in the collection
public bool Contains(Peer item)	Determines whether the peer by id is in the collection
public void CopyTo(Peer[] array, int arrayIndex)	Copies peers of the collection to an array
public bool Equals(Peer x, Peer y)	Determines whether the peers are equal
public IEnumerator<Peer> GetEnumerator()	Get enumerator for iteration
public int GetHashCode(Peer obj)	Default GetHashCode
public bool Remove(ulong id)	Remove a peer by id from the collection
public bool Remove(Peer item)	Remove a peer by id from the collection
IEnumerator IEnumerable.GetEnumerator()

ConnectionStateChangedEventArgs Class

Definition

Name: ConnectionStateChangedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedeventargs

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Description
public NativeBindings.OdinRoomConnectionState ConnectionState { get; }	Connection state of the ODIN client
public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }	Reason of connection state
public int Retry { get; }	Connection retry count

MediaActiveStateChangedEventArgs Class

Definition

Name: MediaActiveStateChangedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedeventargs

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Description
public long MediaStreamId { get; }	stream handle id
public ulong PeerId { get; }	peer id
public bool Active { get; }	state of the media

MediaAddedEventArgs Class

Definition

Name: MediaAddedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaaddedeventargs

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Description
public ulong PeerId { get; }	peer id
public Peer Peer	peer object
public PlaybackStream Media	Media

MediaRemovedEventArgs Class

Definition

Name: MediaRemovedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaremovedeventargs

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Description
public long MediaStreamId { get; }	stream handle id
public Peer Peer	peer object

MessageReceivedEventArgs Class

Definition

Name: MessageReceivedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/messagereceivedeventargs

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Description
public ulong PeerId { get; }	peer id
public byte[] Data	arbitrary data

PeerJoinedEventArgs Class

Definition

Name: PeerJoinedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peerjoinedeventargs

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Description
public ulong PeerId { get; }	peer Id
public string UserId { get; }	user Id
public Peer Peer	peer object

PeerLeftEventArgs Class

Definition

Name: PeerLeftEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peerlefteventargs

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Description
public ulong PeerId { get; }	peer id

PeerUserDataChangedEventArgs Class

Definition

Name: PeerUserDataChangedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedeventargs

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Description
public ulong PeerId { get; }	peer id
public Peer Peer	peer object
public UserData UserData	peer userdata

Room Class

Definition

Name: Room
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/room

public class Room : IDisposable

Main Room

Properties

Name	Description
public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }	ConnectionState of the Room that is set by ODIN
public int ConnectionRetry { get; }	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
public readonly RoomConfig Config	Room configuration
public bool IsJoined { get; }	true on successful Join or false
public Peer Self { get; }	Client Peer
public UserData RoomUserData { get; }	Odin UserData helper for marshal byte arrays on Room level
public PeerCollection RemotePeers { get; }	Conatiner of room peers
public IEnumerable<MediaCollection> PlaybackMedias { get; }	Get all medias of room peers
public MicrophoneStream MicrophoneMedia { get; }	Current room microphone data route

Methods

Name	Description
public string GetRoomId()	Retrieves the room ID (e.g. the name of the room)
public string GetRoomCustomer()	Retrieves the identifier of the customer the room
public ulong GetRoomPeerId()	Retrieves your own peer ID
public OdinConnectionStats GetRoomConnectionStats()	Retrieves statistics for the underlying connection of this room
public bool SetApmConfig(OdinRoomConfig config)	Set rooms new Apm config
public bool Join(string name, string userId, IUserData userData = null)	Join the room via Odin gateway
public bool Join(string token)	Join the room via Odin gateway
public bool CreateMicrophoneMedia(OdinMediaConfig config)	Try to add a MicrophoneMedia
public bool UpdatePeerUserData(IUserData userData)	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
public bool SendMessage(ulong[] peerIdList, byte[] data)	Sends arbitrary data to a array of target peerIds.
public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)	Sends arbitrary data to a array of target peerIds.
public bool BroadcastMessage(byte[] data, bool includeSelf = false)	Sends arbitrary data to a all remote peers in this room.
public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)	Sends arbitrary data to a all remote peers in this room.
public List<ulong> GetRemotePeersIds(bool includeSelf)	Get a copy of all PeerIds in this room
public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()	All ids of Media from remote peers in this room
public bool SetPositionScale(float scale)	Configures the allowed 'view' distance for proximity calculation of peers in the room
public bool UpdatePosition(float x, float y)	Updates the two-dimensional position of our own peer in the room
public bool AudioProcessReverse(float[] buffer)	Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.This should only be done if you are NOT using AudioMixStreams(RoomHandle%2cStreamHandle%5b%5d%2cSystem.
public override string ToString()	Debug
public void Leave()	Leave a room and free all remote peers and associated medias
public void Dispose()	On dispose will free the room and token generator

RoomCollection Class

Definition

Name: RoomCollection
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomcollection

public class RoomCollection : IReadOnlyCollection&lt;Room&gt;, IEnumerable&lt;Room&gt;, IEnumerable, IEqualityComparer&lt;Room&gt;

Intern room dictionary

Properties

Name	Description
public Room this[string key] { get; }	Try to get room by name
public int Count { get; }	Count of rooms in the collection
public bool IsRemoveOnly { get; }	Indicates whether elements can be removed from the collection

Methods

Name	Description
public bool Add(Room item)	Add a room to the collection
public void Clear()	Free and empty the collection
public bool Contains(string key)	Determines whether the room by name/token is in the collection
public bool Contains(Room item)	Determines whether the room by name/token is in the collection
public void CopyTo(Room[] array, int arrayIndex)	Copies rooms of the collection to an array
public bool Equals(Room x, Room y)	Compares two rooms by name
public IEnumerator<Room> GetEnumerator()	Get enumerator for iteration
public int GetHashCode(Room obj)	Default GetHashCode
public bool Remove(string key)	Removes the room from this collection
public bool Remove(Room item)	Removes the room from this collection
public void Leave(string key)	Get the room and leave
IEnumerator IEnumerable.GetEnumerator()

RoomConfig Class

Definition

Name: RoomConfig
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomconfig

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Description
public string AccessKey	Room associated AccessKey
public ulong TokenLifetime	Room associated Token lifetime
public string Name	Room name
public string Token	Room token
public string Server	Room associated endpoint
public bool HasEventCallbacks	true if Room where set and registered in ODIN ffi
public OdinRoomConfig ApmConfig	Configuration for NativeBindings
public OdinMediaConfig PlaybackMediaConfig	Configuration for Media on new medias

Methods

Name	Description
public override string ToString()	Debug

RoomJoinEventArgs Class

Definition

Name: RoomJoinEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomjoineventargs

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Description
public Room Room	room object

RoomJoinedEventArgs Class

Definition

Name: RoomJoinedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomjoinedeventargs

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Description
public Room Room	room object

RoomLeaveEventArgs Class

Definition

Name: RoomLeaveEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomleaveeventargs

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Description
public Room Room	room object

RoomLeftEventArgs Class

Definition

Name: RoomLeftEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomlefteventargs

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Description
public string RoomName	room name

RoomUserDataChangedEventArgs Class

Definition

Name: RoomUserDataChangedEventArgs
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedeventargs

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Description
public string RoomName { get; }	room name
public UserData Data	room userdata

UserData Class

Definition

Name: UserData
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/userdata

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Properties

Name	Description
public Encoding Encoding { get; set; }	Default Encoding
public byte[] Buffer { get; set; }	Raw UserData

Methods

Name	Description
public virtual void CopyFrom(IntPtr ptr, ulong size)	Copies data from memory to Buffer
public virtual bool IsEmpty()	Indicates whether data is null or empty
public virtual bool Contains(string value)	Indicates whether substring occurs
public virtual bool Contains(byte value)	Indicates whether substring occurs
public virtual IEnumerable<int> PatternAt(byte[] pattern)	Indicates whether two sequence are equal
public virtual UserData Clone()	Creates a shallow copy of the Buffer
public virtual byte[] ToBytes()	Used for converting Data on network level
public override string ToString()	String representation of Buffer based on the specified encoding

MicrophoneReader Class

Definition

Name: MicrophoneReader
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/microphonereader

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Description
public bool HasPermission { get; }	Check if the user has authorized use of the microphone
public bool RedirectCapturedAudio	Skips registered PushAudio for the OnMicrophoneData event
public bool SilenceCapturedAudio	Zero out the event audio buffer for PushAudio.
public bool ContinueRecording
public int AudioClipLength
public bool OverrideSampleRate	Use set DeviceSampleRate on false
public MediaSampleRate SampleRate	The recording Core
public bool CustomInputDevice	Enable/Disable the use of InputDevice as a new/fixed device name
public string InputDevice	The device name to use as microphone in Unity. (i.e Microphone.Start)
public bool AutostartListen	Use (Microphone.Start) in MicrophoneReader
public bool CustomMicVolumeScale
public float MicVolumeScale
public bool Loopback	Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound.
public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData	Event is fired if raw microphone data is available

Methods

Name	Description
public bool StartListen()	Start Unity microphone capture
public void StopListen()	Stop Unity Microphone capture if this AudioSender created the recording

PlaybackComponent Class

Definition

Name: PlaybackComponent
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/playbackcomponent

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Properties

Name	Description
public AudioSource PlaybackSource	The Unity AudioSource component for playback
public bool AutoDestroyAudioSource	On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources
public bool AutoDestroyMediaStream	On true destroy the Media in dispose to not leak or false for manually manage stream
public MediaSampleRate SampleRate	The playback Core
public bool Mute { get; set; }	The Unity AudioSource mute property
public string RoomName { get; set; }	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
public ulong PeerId { get; set; }	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
public long MediaStreamId { get; set; }	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
public bool HasActivity { get; }

Methods

Name	Description
public void SetMediaInfo(string roomName, ulong peerId, long mediaId)
public NativeBindings.OdinAudioStreamStats GetOdinAudioStreamStats()

PlaybackStats Class

Definition

Name: PlaybackStats
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/playbackstats

public class PlaybackStats : MonoBehaviour

Properties

Name	Description
public bool Log
public bool PauseAnimationCurve
public uint PacketsProcessed
public uint PacketsDroppedEarly
public uint PacketsDroppedLate
public uint PacketsLost
public AnimationCurve PacketsAvailableDifference

ConnectionStateChangedProxy Class

Definition

Name: ConnectionStateChangedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedproxy

[Serializable]
public class ConnectionStateChangedProxy : UnityEvent&lt;object, ConnectionStateChangedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

MediaActiveStateChangedProxy Class

Definition

Name: MediaActiveStateChangedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedproxy

[Serializable]
public class MediaActiveStateChangedProxy : UnityEvent&lt;object, MediaActiveStateChangedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

MediaAddedProxy Class

Definition

Name: MediaAddedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaaddedproxy

[Serializable]
public class MediaAddedProxy : UnityEvent&lt;object, MediaAddedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

MediaRemovedProxy Class

Definition

Name: MediaRemovedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/mediaremovedproxy

[Serializable]
public class MediaRemovedProxy : UnityEvent&lt;object, MediaRemovedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

MessageReceivedProxy Class

Definition

Name: MessageReceivedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/messagereceivedproxy

[Serializable]
public class MessageReceivedProxy : UnityEvent&lt;object, MessageReceivedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

PeerJoinedProxy Class

Definition

Name: PeerJoinedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peerjoinedproxy

[Serializable]
public class PeerJoinedProxy : UnityEvent&lt;object, PeerJoinedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

PeerLeftProxy Class

Definition

Name: PeerLeftProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peerleftproxy

[Serializable]
public class PeerLeftProxy : UnityEvent&lt;object, PeerLeftEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

PeerUserDataChangedProxy Class

Definition

Name: PeerUserDataChangedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedproxy

[Serializable]
public class PeerUserDataChangedProxy : UnityEvent&lt;object, PeerUserDataChangedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

RoomJoinProxy Class

Definition

Name: RoomJoinProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomjoinproxy

[Serializable]
public class RoomJoinProxy : UnityEvent&lt;RoomJoinEventArgs&gt;

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

RoomJoinedProxy Class

Definition

Name: RoomJoinedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomjoinedproxy

[Serializable]
public class RoomJoinedProxy : UnityEvent&lt;RoomJoinedEventArgs&gt;

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

RoomLeaveProxy Class

Definition

Name: RoomLeaveProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomleaveproxy

[Serializable]
public class RoomLeaveProxy : UnityEvent&lt;RoomLeaveEventArgs&gt;

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

RoomLeftProxy Class

Definition

Name: RoomLeftProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomleftproxy

[Serializable]
public class RoomLeftProxy : UnityEvent&lt;RoomLeftEventArgs&gt;

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

RoomUserDataChangedProxy Class

Definition

Name: RoomUserDataChangedProxy
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedproxy

[Serializable]
public class RoomUserDataChangedProxy : UnityEvent&lt;object, RoomUserDataChangedEventArgs&gt;

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

UnityCreatedMediaObject Class

Definition

Name: UnityCreatedMediaObject
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/unitycreatedmediaobject

[Serializable]
public class UnityCreatedMediaObject : UnityEvent&lt;string, ulong, long&gt;

UnityDeleteMediaObject Class

Definition

Name: UnityDeleteMediaObject
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/unitydeletemediaobject

[Serializable]
public class UnityDeleteMediaObject : UnityEvent&lt;long&gt;

Unity Inspector event wrapper (UnityEvent)

OdinBanner Class

Definition

Name: OdinBanner
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odinbanner

public class OdinBanner : MonoBehaviour

OdinEditorConfig Class

Definition

Name: OdinEditorConfig
Link to documentation: https://www.4players.io/odin/sdk/unity/classes/odineditorconfig

public class OdinEditorConfig : MonoBehaviour

UnityEditor UI component for instance config of Odin

Properties

Name	Description
public bool Verbose	Enable additional Logs
public bool VerboseDebug	Enable additional Logs
public string AccessKey	Odin Client ApiKey
public string ClientId	Odin Client ID
public string Server	Gateway
public string UserDataText	Default UserData content
public MediaSampleRate DeviceSampleRate	Microphone Sample-Rate
public MediaChannels DeviceChannels	Microphone Channels
public MediaSampleRate RemoteSampleRate	Playback Sample-Rate
public MediaChannels RemoteChannels	Playback Channels
public bool PeerJoinedEvent
public bool PeerLeftEvent
public bool PeerUpdatedEvent
public bool MediaAddedEvent
public bool MediaRemovedEvent
public bool RoomUpdatedEvent
public bool MediaActiveStateChangedEvent
public bool MessageReceivedEvent
public ulong TokenLifetime	Time untill the token expires
public bool VoiceActivityDetection	Turns VAD on and off
public float VoiceActivityDetectionAttackProbability	Setup engage of VAD
public float VoiceActivityDetectionReleaseProbability	Setup disengage of VAD
public bool VolumeGate	Turns volume gate on and off
public float VolumeGateAttackLoudness	Setup engage of volume gate
public float VolumeGateReleaseLoudness	Setup disengage of volume gate
public bool EchoCanceller	Turns Echo cancellation on and off
public bool HighPassFilter	Reduces lower frequencies of the input (Automatic game control)
public bool PreAmplifier	Amplifies the audio input
public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel	Turns noise suppression on and off
public bool TransientSuppressor	Filters high amplitude noices
public bool GainController	Turns gain controller on and off

Methods

Name	Description
public void GenerateUIAccessKey()

Interfaces

IOdinApmConfig Interface

Definition

Name: IOdinApmConfig
Link to documentation: https://www.4players.io/odin/sdk/unity/interfaces/iodinapmconfig

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

IUserData Interface

Definition

Name: IUserData
Link to documentation: https://www.4players.io/odin/sdk/unity/interfaces/iuserdata

public interface IUserData

interface for transmitting UserData

Methods

Name	Description
bool IsEmpty()	Indicates whether data is null or empty
byte[] ToBytes()	Used for converting Data on network level

Structs

OdinAudioStreamStats Struct

Definition

Name: OdinAudioStreamStats
Link to documentation: https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats

public struct OdinAudioStreamStats

Audio stream statistics.

Properties

Name	Description
public uint jitter_packets_processed	The number of packets processed by the medias jitter buffer.
public uint jitter_packets_dropped_too_early	The number of packets dropped because they seemed to arrive too early.
public uint jitter_packets_dropped_too_late	The number of packets processed because they seemed to arrive too late.
public uint jitter_packets_lost	The number of packets marked as lost during transmission.

OdinConnectionStats Struct

Definition

Name: OdinConnectionStats
Link to documentation: https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats

public struct OdinConnectionStats

Statistics for the underlying connection of a room.

Properties

Name	Description
public ulong udp_tx_datagrams	The amount of outgoing UDP datagrams observed
public ulong udp_tx_acks	The amount of outgoing acknowledgement frames observed
public ulong udp_tx_bytes	The total amount of bytes which have been transferred inside outgoing UDP datagrams
public ulong udp_rx_datagrams	The amount of incoming UDP datagrams observed
public ulong udp_rx_acks	The amount of incoming acknowledgement frames observed
public ulong udp_rx_bytes	The total amount of bytes which have been transferred inside incoming UDP datagrams
public ulong cwnd	Current congestion window of the connection
public ulong congestion_events	Congestion events on the connection
public float rtt	Current best estimate of the connection latency (round-trip-time) in milliseconds

Enums

OdinNoiseSuppressionLevel Enum

Definition

Name: OdinNoiseSuppressionLevel
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Description
None = 0	None
Low = 1	6dB
Moderate = 2	12 dB
High = 3	18 dB
VeryHigh = 4	21 dB

OdinRoomConnectionState Enum

Definition

Name: OdinRoomConnectionState
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstate

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Description
Connecting = 0	Connection is being established
Connected = 1	Connection is established
Disconnected = 2	Connection is closed

OdinRoomConnectionStateChangeReason Enum

Definition

Name: OdinRoomConnectionStateChangeReason
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstatechangereason

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Description
ClientRequested = 0	Connection state change was initiated by the user
ServerRequested = 1	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost = 2	Connection state change was caused by a timeout

MediaChannels Enum

Definition

Name: MediaChannels
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/mediachannels

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Description
Mono = 1	Defines a single (monaural) channel
Stereo = 2	Defines two (stereo) channels

MediaSampleRate Enum

Definition

Name: MediaSampleRate
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/mediasamplerate

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Description
Device_Min = 0U	Hardware device min samplerate
Device_Max = 1U	Hardware device max samplerate
Hz8000 = 8000U	8khz
Hz11025 = 11025U	11.025khz
Hz12000 = 12000U	12khz
Hz16000 = 16000U	16khz
Hz22050 = 22050U	22.05khz
Hz24000 = 24000U	24khz
Hz32000 = 32000U	32khz
Hz44100 = 44100U	44.1khz
Hz48000 = 48000U	48khz
Hz96000 = 96000U	96khz
Hz128000 = 128000U	128khz
Hz144000 = 144000U	144khz
Hz192000 = 192000U	192khz

SupportedPlatform Enum

Definition

Name: SupportedPlatform
Link to documentation: https://www.4players.io/odin/sdk/unity/enums/supportedplatform

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Description
Android = 0
iOS = 1
MacOSX = 2
Linux = 3
Windows = 4

Delegates

MediaActiveStateChangedEventHandler Delegate

Definition

Name: MediaActiveStateChangedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/mediaactivestatechangedeventhandler

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

RoomConnectionStateChangedEventHandler Delegate

Definition

Name: RoomConnectionStateChangedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roomconnectionstatechangedeventhandler

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

RoomMediaAddedEventHandler Delegate

Definition

Name: RoomMediaAddedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roommediaaddedeventhandler

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

RoomMediaRemovedEventHandler Delegate

Definition

Name: RoomMediaRemovedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roommediaremovedeventhandler

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

RoomMessageReceivedEventHandler Delegate

Definition

Name: RoomMessageReceivedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roommessagereceivedeventhandler

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

RoomPeerJoinedEventHandler Delegate

Definition

Name: RoomPeerJoinedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roompeerjoinedeventhandler

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

RoomPeerLeftEventHandler Delegate

Definition

Name: RoomPeerLeftEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roompeerlefteventhandler

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

RoomPeerUserDataChangedEventHandler Delegate

Definition

Name: RoomPeerUserDataChangedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roompeeruserdatachangedeventhandler

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

RoomUserDataChangedEventHandler Delegate

Definition

Name: RoomUserDataChangedEventHandler
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/roomuserdatachangedeventhandler

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.

MicrophoneCallbackDelegate Delegate

Definition

Name: MicrophoneCallbackDelegate
Link to documentation: https://www.4players.io/odin/sdk/unity/delegates/microphonecallbackdelegate

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

`}),e.add({id:11,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:12,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:13,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Odin Client ApiKey ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string AccessKey

Odin Client ApiKey

Value Type

Type	Description
String

`}),e.add({id:14,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Room associated AccessKey ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string AccessKey

Room associated AccessKey

Value Type

Type	Description
String

`}),e.add({id:15,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:16,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:17,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Odin Client ApiKey ",content:`

public string AccessKey

Odin Client ApiKey

Value Type

Type	Description
String

`}),e.add({id:18,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Room associated AccessKey ",content:`

public string AccessKey

Room associated AccessKey

Value Type

Type	Description
String

`}),e.add({id:19,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:20,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:21,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Odin Client ApiKey ",content:`

public string AccessKey

Odin Client ApiKey

Value Type

Type	Description
String

`}),e.add({id:22,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Room associated AccessKey ",content:`

public string AccessKey

Room associated AccessKey

Value Type

Type	Description
String

`}),e.add({id:23,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:24,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:25,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Odin Client ApiKey ",content:`

public string AccessKey

Odin Client ApiKey

Value Type

Type	Description
String

`}),e.add({id:26,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Room associated AccessKey ",content:`

public string AccessKey

Room associated AccessKey

Value Type

Type	Description
String

`}),e.add({id:27,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:28,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:29,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Client AccessKey for all new rooms. Default from OdinHandler config. ",content:`

public string AccessKey { get; }

Client AccessKey for all new rooms. Default from OdinHandler config.

Value Type

Type	Description
String

`}),e.add({id:30,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Default access key ",content:`

public static string AccessKey { get; set; }

Default access key

Value Type

Type	Description
String

`}),e.add({id:31,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Odin Client ApiKey ",content:`

public string AccessKey

Odin Client ApiKey

Value Type

Type	Description
String

`}),e.add({id:32,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/accesskey/",title:"AccessKey",section:"ODIN Documentation",description:" Room associated AccessKey ",content:`

public string AccessKey

Room associated AccessKey

Value Type

Type	Description
String

`}),e.add({id:33,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/active/",title:"active",section:"ODIN Documentation",description:"Indicates wether or not the media is currently sending/receiving data.",content:`

boolean

Indicates wether or not the media is currently sending/receiving data.

`}),e.add({id:34,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:35,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:36,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:37,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:38,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:39,href:"https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedeventargs/active/",title:"Active",section:"ODIN Documentation",description:" state of the media ",content:`

public bool Active { get; }

state of the media

Value Type

Type	Description
Boolean

`}),e.add({id:40,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/activity/",title:"Activity",section:"ODIN Documentation",description:" Media activity state flag ",content:`

public bool Activity { get; }

Media activity state flag

Value Type

Type	Description
Boolean

`}),e.add({id:41,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediaevents/activity/",title:"Activity",section:"ODIN Documentation",description:"The media is sending/receiving data.",content:`

OdinMediaActivityChangedEvent

The media is sending/receiving data.

Parameters

Name	Type	Description
item	MediaStream	stream to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:43,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Add(Peer item)

Add a peer to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:44,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:45,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(MediaStream item)

Add a stream to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:46,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Peer item)

Add a peer to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:47,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:48,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(MediaStream item)

Add a stream to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:49,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Peer item)

Add a peer to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:50,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:51,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(MediaStream item)

Add a stream to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:52,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Peer item)

Add a peer to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:53,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:54,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:55,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(MediaStream item)

Add a stream to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:56,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Peer item)

Add a peer to the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:57,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/add/",title:"Add",section:"ODIN Documentation",description:"",content:`

public bool Add(Room item)

Add a room to the collection

Info

Always false if the collection IsRemoveOnly

Parameters

Name	Type	Description
item	Room	room to add

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:58,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/addapm/",title:"AddApm",section:"ODIN Documentation",description:"",content:`

public virtual OdinApmComponent AddApm()

Returns

Type	Description
OdinApmComponent

`}),e.add({id:59,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/addapmeffect/",title:"AddApmEffect",section:"ODIN Documentation",description:"",content:`

public ApmEffect AddApmEffect(uint samplerate, bool stereo, OdinApmConfig config)

Insert a apm effect and sets the apm config

Parameters

Name	Type	Description
samplerate	UInt32	effect playback samplerate
stereo	Boolean	effect playback stereo
config	OdinApmConfig	configuration settings for apm

Returns

Type	Description
ApmEffect	instance of base :

`}),e.add({id:60,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/addcustomeffect/",title:"AddCustomEffect",section:"ODIN Documentation",description:"",content:`

public CustomEffect<T> AddCustomEffect<T>(Action<OdinCallbackAudioData, T> callback, T userData)
    where T : struct

Insert a custom effect and sets the Media where T marks Serialize/Deserialize structures

Parameters

Name	Type	Description
callback	Action<OdinCallbackAudioData,<T>>	effect callback
userData	<T>	effect callback userdata of type `T`

Returns

Type	Description
CustomEffect<<T>>	instance of base :

`}),e.add({id:61,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/addeffect/",title:"AddEffect",section:"ODIN Documentation",description:"",content:`

public T AddEffect<T>()
    where T : MonoBehaviour, IOdinEffect
public T AddEffect<T>(T effect)
    where T : MonoBehaviour, IOdinEffect
public CustomEffect<T> AddEffect<T>(UnityAction<OdinCallbackAudioData, T> callback, T userData)
    where T : struct

Parameters

Name	Type	Description
effect	<T>
callback	UnityAction<OdinCallbackAudioData,<T>>
userData	<T>

Returns

Type	Description
<T>
CustomEffect<<T>>

Variants

AddEffect()

public T AddEffect<T>()
    where T : MonoBehaviour, IOdinEffect

Returns

Type	Description
<T>

AddEffect(effect)

public T AddEffect<T>(T effect)
    where T : MonoBehaviour, IOdinEffect

Parameters

Name	Type	Description
effect	<T>

Returns

Type	Description
<T>

AddEffect(callback, userData)

public CustomEffect<T> AddEffect<T>(UnityAction<OdinCallbackAudioData, T> callback, T userData)
    where T : struct

Parameters

Name	Type	Description
callback	UnityAction<OdinCallbackAudioData,<T>>
userData	<T>

Returns

Type	Description
CustomEffect<<T>>

`}),e.add({id:62,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/addeventlistener/",title:"addEventListener",section:"ODIN Documentation",description:"Adds an event listener to the room for specific events.",content:`

public addEventListener(eventName: Event, handler: OdinEvents[Event]): void

Adds an event listener to the room for specific events.

Parameters

Name	Type	Description
eventName	Event	The event to listen for (see keys of OdinEvents for possible values)
handler	OdinEvents[Event]	The callback to call when the event is fired.

Returns

Type	Description
void

`}),e.add({id:63,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/addeventlistener/",title:"addEventListener",section:"ODIN Documentation",description:"Registers to client events from `IOdinClientEvents`.",content:`

addEventListener(eventName: Event, handler: IOdinClientEvents[Event]): void

Registers to client events from IOdinClientEvents.

Parameters

Name	Type	Description
eventName	Event	The name of the event to listen to
handler	IOdinClientEvents[Event]	The callback to handle the event

Returns

Type	Description
void

`}),e.add({id:64,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/addeventlistener/",title:"addEventListener",section:"ODIN Documentation",description:"Registers to media events from `IOdinMediaEvents`.",content:`

addEventListener(eventName: Event, handler: IOdinMediaEvents[Event]): void

Registers to media events from IOdinMediaEvents.

Parameters

Name	Type	Description
eventName	Event	The name of the event to listen to
handler	IOdinMediaEvents[Event]	The callback to handle the event

Returns

Type	Description
void

`}),e.add({id:65,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/addeventlistener/",title:"addEventListener",section:"ODIN Documentation",description:"Registers to peer events from `IOdinPeerEvents`.",content:`

addEventListener(eventName: Event, handler: IOdinPeerEvents[Event]): void

Registers to peer events from IOdinPeerEvents.

Parameters

Name	Type	Description
eventName	Event	The name of the event to listen to
handler	IOdinPeerEvents[Event]	The callback to handle the event

Returns

Type	Description
void

`}),e.add({id:66,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/addeventlistener/",title:"addEventListener",section:"ODIN Documentation",description:"Register to peer events from `IOdinRoomEvents`.",content:`

addEventListener(eventName: OdinEvent, handler: IOdinRoomEvents[OdinEvent]): void

Parameters

Name	Type	Description
eventName	OdinEvent	The name of the event to listen to
handler	IOdinRoomEvents[OdinEvent]	The callback to handle the event

Returns

Type	Description
void

`}),e.add({id:67,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/addmedia/",title:"addMedia",section:"ODIN Documentation",description:"Adds a media to the list of active medias and starts decoding.",content:`

addMedia(media: OdinMedia): void

Adds a media to the list of active medias and starts decoding.

Parameters

Name	Type	Description
media	OdinMedia	The media instance to add

Returns

Type	Description
void

`}),e.add({id:68,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/addmedia/",title:"AddMedia",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void AddMedia(PlaybackStream stream)

Associate a media with the peer

Parameters

Name	Type	Description
stream	PlaybackStream	media stream

`}),e.add({id:69,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/addmedia/",title:"AddMedia",section:"ODIN Documentation",description:"",content:`

public void AddMedia(PlaybackStream stream)

Associate a media with the peer

Parameters

Name	Type	Description
stream	PlaybackStream	media stream

`}),e.add({id:70,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/addmedia/",title:"AddMedia",section:"ODIN Documentation",description:"",content:`

public void AddMedia(PlaybackStream stream)

Associate a media with the peer

Parameters

Name	Type	Description
stream	PlaybackStream	media stream

`}),e.add({id:71,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/addmedia/",title:"AddMedia",section:"ODIN Documentation",description:"",content:`

public void AddMedia(PlaybackStream stream)

Associate a media with the peer

Parameters

Name	Type	Description
stream	PlaybackStream	media stream

`}),e.add({id:72,href:"https://www.4players.io/odin/sdk/unity/classes/peer/addmedia/",title:"AddMedia",section:"ODIN Documentation",description:"",content:`

public void AddMedia(PlaybackStream stream)

Associate a media with the peer

Parameters

Name	Type	Description
stream	PlaybackStream	media stream

`}),e.add({id:73,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/addmediacomponent/",title:"AddMediaComponent",section:"ODIN Documentation",description:"",content:`

public OdinMedia AddMediaComponent(GameObject containerObject, ushort mediaId, bool enable = true)
public OdinMedia AddMediaComponent(GameObject containerObject, ushort mediaId, uint samplerate, bool stereo, bool enable = true)

Create a Unity component

Parameters

Name	Type	Description
containerObject	GameObject	gameobject where the component will be added
mediaId	UInt16	id of
enable	Boolean	flag if the new component is enabled
samplerate	UInt32	decoder samplerate
stereo	Boolean	decoder channel flag

Returns

Type	Description
OdinMedia	created component

Variants

AddMediaComponent(containerObject, mediaId, enable)

public OdinMedia AddMediaComponent(GameObject containerObject, ushort mediaId, bool enable = true)

Create a Unity component

Parameters

Name	Type	Description
containerObject	GameObject	gameobject where the component will be added
mediaId	UInt16	id of
enable	Boolean	flag if the new component is enabled

Returns

Type	Description
OdinMedia	created component

AddMediaComponent(containerObject, mediaId, samplerate, stereo, enable)

public OdinMedia AddMediaComponent(GameObject containerObject, ushort mediaId, uint samplerate, bool stereo, bool enable = true)

Create a Unity component

Parameters

Name	Type	Description
containerObject	GameObject	gameobject where the component will be added
mediaId	UInt16	id of
samplerate	UInt32	decoder samplerate
stereo	Boolean	decoder channel flag
enable	Boolean	flag if the new component is enabled

Returns

Type	Description
OdinMedia	created component

`}),e.add({id:74,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/addmute/",title:"AddMute",section:"ODIN Documentation",description:"",content:`

public virtual OdinMuteAudioComponent AddMute()

Returns

Type	Description
OdinMuteAudioComponent

`}),e.add({id:75,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/addpeercomponent/",title:"AddPeerComponent",section:"ODIN Documentation",description:"",content:`

public OdinPeer AddPeerComponent(GameObject containerObject, ulong peerId, bool enable = true)

Add Unity to a gameobject

Parameters

Name	Type	Description
containerObject	GameObject	gameobject where the component will be added
peerId	UInt64	id of
enable	Boolean	flag if the new component is enabled

Returns

Type	Description
OdinPeer	created component

`}),e.add({id:76,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource
peerContainer	GameObject	GameObject to attach to

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Variants

AddPlaybackComponent(gameObjectTag, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

AddPlaybackComponent(peerContainer, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Adds a new PlaybackComponent to the specified GameObject

Parameters

Name	Type	Description
peerContainer	GameObject	GameObject to attach to
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

`}),e.add({id:77,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource
peerContainer	GameObject	GameObject to attach to

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Variants

AddPlaybackComponent(gameObjectTag, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

AddPlaybackComponent(peerContainer, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Adds a new PlaybackComponent to the specified GameObject

Parameters

Name	Type	Description
peerContainer	GameObject	GameObject to attach to
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

`}),e.add({id:78,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource
peerContainer	GameObject	GameObject to attach to

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Variants

AddPlaybackComponent(gameObjectTag, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

AddPlaybackComponent(peerContainer, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Adds a new PlaybackComponent to the specified GameObject

Parameters

Name	Type	Description
peerContainer	GameObject	GameObject to attach to
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

`}),e.add({id:79,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource
peerContainer	GameObject	GameObject to attach to

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Variants

AddPlaybackComponent(gameObjectTag, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

AddPlaybackComponent(peerContainer, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Adds a new PlaybackComponent to the specified GameObject

Parameters

Name	Type	Description
peerContainer	GameObject	GameObject to attach to
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

`}),e.add({id:80,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)
public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource
peerContainer	GameObject	GameObject to attach to

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Discussion

Creates a PlaybackComponent and attaches it to a GameObject. You can either provide a GameObject tag or you can also provide a GameObject directly. The PlaybackComponent is the audio representation of a peer connected in an ODIN room. Use this function to create a PlaybackComponent connected to the ODIN peer and attach it to the GameObject (i.e. the corresponding player object).

graph LR;
    subgraph Unity Scene
        subgraph Player1 [Player 1]
            PBC1[PlaybackComponent]-->GO1[GameObject]                   
        end
        subgraph Player2 [Player 2]
            PBC2[PlaybackComponent]-->GO2[GameObject]
        end
        
    end
    subgraph ODON Server
        subgraph ODIN Room
            Peer1[Peer 1] --> PBC1
            Peer2[Peer 2] --> PBC2
        end    
    end    
    classDef blue fill:#DDFAFF
    class Player1,Player2 blue

The best place to call this function is in the callback OnCreatedMediaObject as you get all relevant info in the callbacks parameters that you need when calling this function. Please see PlaybackComponent for more info on available settings.

Variants

AddPlaybackComponent(gameObjectTag, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(string gameObjectTag, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Tries to identifiy a gameobject by tag to assign the PlaybackComponent

Parameters

Name	Type	Description
gameObjectTag	String	Tag string to find with FindGameObjectsWithTag
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

AddPlaybackComponent(peerContainer, roomName, peerId, mediaStreamId, autoDestroySource)

public PlaybackComponent AddPlaybackComponent(GameObject peerContainer, string roomName, ulong peerId, long mediaStreamId, bool autoDestroySource = true)

Adds a new PlaybackComponent to the specified GameObject

Parameters

Name	Type	Description
peerContainer	GameObject	GameObject to attach to
roomName	String	PlaybackComponent room
peerId	UInt64	PlaybackComponent peer
mediaStreamId	Int64	PlaybackComponent media
autoDestroySource	Boolean	optionally enable or disable on destroy of PlaybackComponent the destroy of the linked AudioSource

Returns

Type	Description
PlaybackComponent	ScriptReference of from the GameObject or null

Example

AddPlaybackComponent Example

private void OnCreatedMediaObject(string roomName, ulong peerId, ushort mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Find the players game object in the scene
    var peerContainer = FindPlayerForPeerId(peerId);

    // Add PlaybackComponent to new dummy PeerCube
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Some AudioSource test settings
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

`}),e.add({id:81,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/addvad/",title:"AddVad",section:"ODIN Documentation",description:"",content:`

public virtual OdinVadComponent AddVad()

Returns

Type	Description
OdinVadComponent

`}),e.add({id:82,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/addvadeffect/",title:"AddVadEffect",section:"ODIN Documentation",description:"",content:`

public bool AddVadEffect(out VadEffect effect)

Insert a vad effect

Info

see VadEffect for more configuration

Parameters

Name	Type	Description
effect	VadEffect	configuration settings for vad

Returns

Type	Description
Boolean	instance of base :

`}),e.add({id:83,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/addvolumeboost/",title:"AddVolumeBoost",section:"ODIN Documentation",description:"",content:`

public virtual OdinVolumeBoostComponent AddVolumeBoost()

Returns

Type	Description
OdinVolumeBoostComponent

`}),e.add({id:84,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:85,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:86,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:87,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:88,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:89,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/android/",title:"Android",section:"ODIN Documentation",description:"",content:`

Android = 0

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:90,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/apmconfig/",title:"ApmConfig",section:"ODIN Documentation",description:" Configuration for ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public OdinRoomConfig ApmConfig

Configuration for NativeBindings

Value Type

Type	Description
OdinRoomConfig

`}),e.add({id:91,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/apmconfig/",title:"ApmConfig",section:"ODIN Documentation",description:" Configuration for ",content:`

public OdinRoomConfig ApmConfig

Configuration for NativeBindings

Value Type

Type	Description
OdinRoomConfig

`}),e.add({id:92,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/apmconfig/",title:"ApmConfig",section:"ODIN Documentation",description:" Configuration for ",content:`

public OdinRoomConfig ApmConfig

Configuration for NativeBindings

Value Type

Type	Description
OdinRoomConfig

`}),e.add({id:93,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/apmconfig/",title:"ApmConfig",section:"ODIN Documentation",description:" Configuration for ",content:`

public OdinRoomConfig ApmConfig

Configuration for NativeBindings

Value Type

Type	Description
OdinRoomConfig

`}),e.add({id:94,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/apmconfig/",title:"ApmConfig",section:"ODIN Documentation",description:" Configuration for ",content:`

public OdinRoomConfig ApmConfig

Configuration for NativeBindings

Value Type

Type	Description
OdinRoomConfig

`}),e.add({id:95,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/",title:"ApmEffect",section:"ODIN Documentation",description:" VoiceActivity effect for ",content:`

Inherits from: PiplineEffect

public class ApmEffect : PiplineEffect, IPiplineEffect

VoiceActivity effect for Odin

Constructors

Name	Description
ApmEffect(OdinPipelineHandle, UInt32)	Internal effect constructor, use UInt32%2cSystem

Static Methods

Name	Description
Create	Insert a apm effect in the specified pipline and sets the apm config

Properties

Name	Description
Config	Audio processing configuration
EchoCanceller	Idicates whether the ApmConfig setting is enabled
HighPassFilter	Idicates whether the ApmConfig setting is enabled
PreAmplifier	Idicates whether the ApmConfig setting is enabled
NoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Idicates whether the ApmConfig setting is enabled
GainController	Idicates whether the ApmConfig setting is enabled
Samplerate	Output decoder samplerate
IsStereo	Output decoder channel flag

Public Methods

Name	Description
UpdateEffectConfig	Set audio processing configuration
SetApmConfig	Set managed audio processing configuration
SetVadConfig	Not supported
GetVadConfig	Not supported

Inherited Properties

Name	Description
Id	Effect id
Index	Effect index
Parent	Pipeline handle

Inherited Methods

Name	Description
GetEffectIndex	Get native effect index
GetEffectType	Get native effect NativeBindings
GetVadConfig	Get native voice activity config
SetApmConfig	Set native audio processing config
SetApmStreamDelay	Set native audio processing delay
SetVadConfig	Set native voice activity config
UpdateApmPlayback	Send samples for native audio processing

`}),e.add({id:96,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/constructor_0/",title:"ApmEffect(OdinPipelineHandle, UInt32)",section:"ODIN Documentation",description:"",content:`

protected ApmEffect(OdinPipelineHandle parentHandle, uint effectId)

Internal effect constructor, use UInt32%2cSystem

Parameters

Name	Description
parentHandle	pipeline handle
effectId	effect id

`}),e.add({id:97,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/append/",title:"Append",section:"ODIN Documentation",description:"",content:`

public void Append(byte[] bytes)

Append bytes to the stream at the currrent stream position

Parameters

Name	Type	Description
bytes	Byte[]	bytes to write

`}),e.add({id:98,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/append/",title:"Append",section:"ODIN Documentation",description:"",content:`

void Append(byte[] bytes)

Parameters

Name	Type	Description
bytes	Byte[]

`}),e.add({id:99,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/array16/",title:"Array16",section:"ODIN Documentation",description:"",content:`

public const byte Array16 = 220

Value Type

Type	Description
Byte

`}),e.add({id:100,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/array32/",title:"Array32",section:"ODIN Documentation",description:"",content:`

public const byte Array32 = 221

Value Type

Type	Description
Byte

`}),e.add({id:101,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/arrayenumerable/",title:"ArrayEnumerable",section:"ODIN Documentation",description:"",content:`

public sealed class ArrayEnumerable : IEnumerable<MsgPackReader>

Constructors

Name	Description
ArrayEnumerable(ref MsgPackReader)

Public Methods

Name	Description
GetEnumerator

`}),e.add({id:102,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/arrayenumerable/constructor_0/",title:"ArrayEnumerable(ref MsgPackReader)",section:"ODIN Documentation",description:"",content:`

public ArrayEnumerable(ref MsgPackReader r)

Parameters

Name	Description
r

`}),e.add({id:103,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/arraylength/",title:"ArrayLength",section:"ODIN Documentation",description:"",content:`

public readonly int ArrayLength { get; }

Value Type

Type	Description
Int32

`}),e.add({id:104,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/asarrayenumerable/",title:"AsArrayEnumerable",section:"ODIN Documentation",description:"",content:`

public MsgPackReader.ArrayEnumerable AsArrayEnumerable()

Returns

Type	Description
ArrayEnumerable

`}),e.add({id:105,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/asmapenumerable/",title:"AsMapEnumerable",section:"ODIN Documentation",description:"",content:`

public MsgPackReader.MapEnumerable AsMapEnumerable()

Returns

Type	Description
MapEnumerable

`}),e.add({id:106,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinsensitivityconfig/attack_threshold/",title:"attack_threshold",section:"ODIN Documentation",description:" when the trigger should engage ",content:`

public float attack_threshold

when the trigger should engage

Value Type

Type	Description
Single

`}),e.add({id:107,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/audiocliplength/",title:"AudioClipLength",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int AudioClipLength

Value Type

Type	Description
Int32

`}),e.add({id:108,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/audiocliplength/",title:"AudioClipLength",section:"ODIN Documentation",description:"",content:`

public int AudioClipLength

Value Type

Type	Description
Int32

`}),e.add({id:109,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/audiocliplength/",title:"AudioClipLength",section:"ODIN Documentation",description:"",content:`

public int AudioClipLength

Value Type

Type	Description
Int32

`}),e.add({id:110,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/audiocliplength/",title:"AudioClipLength",section:"ODIN Documentation",description:"",content:`

public int AudioClipLength

Value Type

Type	Description
Int32

`}),e.add({id:111,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/audiocliplength/",title:"AudioClipLength",section:"ODIN Documentation",description:"",content:`

public int AudioClipLength

Value Type

Type	Description
Int32

`}),e.add({id:112,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/audiodata/",title:"AudioData",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinAudioData AudioData { get; }

Value Type

Type	Description
OdinAudioData

`}),e.add({id:113,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual uint AudioDataLength()

Get the number of samples available in the audio buffer.

Returns

Type	Description
UInt32	floats available to read with

`}),e.add({id:114,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonestream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override uint AudioDataLength()

Get the number of samples available in the audio buffer.

Info

Always returns 0

Returns

Type	Description
UInt32	0

`}),e.add({id:115,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioDataLength()

Get the number of samples available in the audio buffer.

Returns

Type	Description
UInt32	floats available to read with

`}),e.add({id:116,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonestream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

public override uint AudioDataLength()

Get the number of samples available in the audio buffer.

Info

Always returns 0

Returns

Type	Description
UInt32	0

`}),e.add({id:117,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioDataLength()

Get the number of samples available in the audio buffer.

Returns

Type	Description
UInt32	floats available to read with

`}),e.add({id:118,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audiodatalength/",title:"AudioDataLength",section:"ODIN Documentation",description:"",content:`

public override uint AudioDataLength()

Get the number of samples available in the audio buffer.

Info

Always returns 0

Returns

Type	Description
UInt32	0

`}),e.add({id:119,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/audiodatareceived/",title:"AudioDataReceived",section:"ODIN Documentation",description:"Fired when audio data is available for media streams. Audio comes in 16 bit and 32 bit float samples and are available individually for each peer. You can use the samples to record audio or send them to an AI for transcription.",content:`

public AudioDataReceived: OdinAudioDataReceivedEvent

Fired when audio data is available for media streams. Audio comes in 16 bit and 32 bit float samples and are available individually for each peer. You can use the samples to record audio or send them to an AI for transcription.

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:121,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/audiomixergroup/",title:"AudioMixerGroup",section:"ODIN Documentation",description:" Unity mixer ",content:`

public AudioMixerGroup AudioMixerGroup

Unity mixer

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:122,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/audioprocessreverse/",title:"AudioProcessReverse",section:"ODIN Documentation",description:"",content:`

public bool AudioProcessReverse(float[] buffer)

Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.This should only be done if you are NOT using AudioMixStreams(RoomHandle%2cStreamHandle%5b%5d%2cSystem.

Parameters

Name	Type	Description
buffer	Single[]	the audio buffer to process

Returns

Type	Description
Boolean	false on error

`}),e.add({id:123,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/audioprocessreverse/",title:"AudioProcessReverse",section:"ODIN Documentation",description:"",content:`

public bool AudioProcessReverse(float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]	the audio buffer to process

Returns

Type	Description
Boolean	false on error

`}),e.add({id:124,href:"https://www.4players.io/odin/sdk/unity/classes/room/audioprocessreverse/",title:"AudioProcessReverse",section:"ODIN Documentation",description:"",content:`

public bool AudioProcessReverse(float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]	the audio buffer to process

Returns

Type	Description
Boolean	false on error

`}),e.add({id:125,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual void AudioPushData(float[] buffer)
public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

Variants

AudioPushData(buffer)

public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data

AudioPushData(buffer, length)

public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

`}),e.add({id:126,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackstream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override void AudioPushData(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:127,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public virtual void AudioPushData(float[] buffer)
public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

Variants

AudioPushData(buffer)

public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data

AudioPushData(buffer, length)

public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

`}),e.add({id:128,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:129,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public virtual void AudioPushData(float[] buffer)
public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

Variants

AudioPushData(buffer)

public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data

AudioPushData(buffer, length)

public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

`}),e.add({id:130,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:131,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public virtual void AudioPushData(float[] buffer, int length)
public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

Variants

AudioPushData(buffer, length)

public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

AudioPushData(buffer)

public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data

`}),e.add({id:132,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer, int length)

Parameters

Name	Type	Description
buffer	Single[]
length	Int32

`}),e.add({id:133,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:134,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public virtual void AudioPushData(float[] buffer, int length)
public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

Variants

AudioPushData(buffer, length)

public virtual void AudioPushData(float[] buffer, int length)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data
length	Int32	bytes to write

AudioPushData(buffer)

public virtual void AudioPushData(float[] buffer)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	audio data

`}),e.add({id:135,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer, int length)

Parameters

Name	Type	Description
buffer	Single[]
length	Int32

`}),e.add({id:136,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstream/audiopushdata/",title:"AudioPushData",section:"ODIN Documentation",description:"",content:`

public override void AudioPushData(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:137,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual async void AudioPushDataAsync(float[] buffer)

Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data

`}),e.add({id:138,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackstream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override void AudioPushDataAsync(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:139,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async void AudioPushDataAsync(float[] buffer)

Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data

`}),e.add({id:140,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public override void AudioPushDataAsync(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:141,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async void AudioPushDataAsync(float[] buffer)

Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data

`}),e.add({id:142,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public override void AudioPushDataAsync(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:143,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async void AudioPushDataAsync(float[] buffer)

Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data

`}),e.add({id:144,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public override void AudioPushDataAsync(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:145,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async void AudioPushDataAsync(float[] buffer)

Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data

`}),e.add({id:146,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstream/audiopushdataasync/",title:"AudioPushDataAsync",section:"ODIN Documentation",description:"",content:`

public override void AudioPushDataAsync(float[] buffer)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:147,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:148,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackstream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:149,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:150,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:151,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:152,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:153,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:154,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:155,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.

Parameters

Name	Type	Description
buffer	Single[]	interleaved audio data
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:156,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstream/audiopushdatatask/",title:"AudioPushDataTask",section:"ODIN Documentation",description:"",content:`

public override Task AudioPushDataTask(float[] buffer, CancellationToken cancellationToken)

AudioPushDataTask and AudioPushDataAsync are not supported!

Info

Remote streams are always readonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task

`}),e.add({id:157,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual uint AudioReadData(float[] buffer)
public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

Variants

AudioReadData(buffer)

public virtual uint AudioReadData(float[] buffer)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
UInt32	count of written bytes into buffer

AudioReadData(buffer, length)

public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

`}),e.add({id:158,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonestream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override uint AudioReadData(float[] buffer)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
UInt32	throws OdinWrapperException

`}),e.add({id:159,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioReadData(float[] buffer)
public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

Variants

AudioReadData(buffer)

public virtual uint AudioReadData(float[] buffer)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
UInt32	count of written bytes into buffer

AudioReadData(buffer, length)

public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

`}),e.add({id:160,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public override uint AudioReadData(float[] buffer)

AudioReadData is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
UInt32	throws OdinWrapperException

`}),e.add({id:161,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioReadData(float[] buffer)
public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

Variants

AudioReadData(buffer)

public virtual uint AudioReadData(float[] buffer)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
UInt32	count of written bytes into buffer

AudioReadData(buffer, length)

public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Warning

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

`}),e.add({id:162,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonestream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public override uint AudioReadData(float[] buffer)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
UInt32	throws OdinWrapperException

`}),e.add({id:163,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioReadData(float[] buffer)
public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

Variants

AudioReadData(buffer)

public virtual uint AudioReadData(float[] buffer)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
UInt32	count of written bytes into buffer

AudioReadData(buffer, length)

public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

`}),e.add({id:164,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public override uint AudioReadData(float[] buffer)

AudioReadData is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
UInt32	throws OdinWrapperException

`}),e.add({id:165,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public virtual uint AudioReadData(float[] buffer)
public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

Variants

AudioReadData(buffer)

public virtual uint AudioReadData(float[] buffer)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
UInt32	count of written bytes into buffer

AudioReadData(buffer, length)

public virtual uint AudioReadData(float[] buffer, int length)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
length	Int32	bytes to read

Returns

Type	Description
UInt32	count of written bytes into buffer

`}),e.add({id:166,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audioreaddata/",title:"AudioReadData",section:"ODIN Documentation",description:"",content:`

public override uint AudioReadData(float[] buffer)

AudioReadData is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
UInt32	throws OdinWrapperException

`}),e.add({id:167,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual async Task<uint> AudioReadDataAsync(float[] buffer)

Read audio data using a custom custom CancellationSource.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:168,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonestream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override Task<uint> AudioReadDataAsync(float[] buffer)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:169,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async Task<uint> AudioReadDataAsync(float[] buffer)

Read audio data using a custom custom CancellationSource.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:170,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataAsync(float[] buffer)

AudioReadDataAsync is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:171,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async Task<uint> AudioReadDataAsync(float[] buffer)

Read audio data using a custom custom CancellationSource.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:172,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonestream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataAsync(float[] buffer)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:173,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async Task<uint> AudioReadDataAsync(float[] buffer)

Read audio data using a custom custom CancellationSource.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:174,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataAsync(float[] buffer)

AudioReadDataAsync is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:175,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public virtual async Task<uint> AudioReadDataAsync(float[] buffer)

Read audio data using a custom custom CancellationSource.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:176,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audioreaddataasync/",title:"AudioReadDataAsync",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataAsync(float[] buffer)

AudioReadDataAsync is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:177,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:178,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonestream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:179,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:180,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

AudioReadDataTask is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:181,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Reads data from the audio stream.

Info

if IsPaused NOP

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:182,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonestream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

AudioReadData and AudioReadDataAsync are not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:183,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:184,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

AudioReadDataTask is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:185,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public virtual Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

Reads data from the audio stream.

Parameters

Name	Type	Description
buffer	Single[]	buffer to write into
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	count of written bytes into buffer

`}),e.add({id:186,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audioreaddatatask/",title:"AudioReadDataTask",section:"ODIN Documentation",description:"",content:`

public override Task<uint> AudioReadDataTask(float[] buffer, CancellationToken cancellationToken)

AudioReadDataTask is not supported!

Info

Microphone streams are always writeonly

Parameters

Name	Type	Description
buffer	Single[]
cancellationToken	CancellationToken

Returns

Type	Description
Task<UInt32>	throws OdinWrapperException

`}),e.add({id:187,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/audioresample/",title:"AudioResample",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Info

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode
UInt32	sample count on success or errorcode on failure

Variants

AudioResample(input, outputSampleRate, output, capacity)

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode

AudioResample(input, outputSampleRate, output, capacity)

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	source buffer
outputSampleRate	UInt32	to samplerate
output	Single[]	target buffer
capacity	Int32	target capacity

Returns

Type	Description
UInt32	sample count on success or errorcode on failure

`}),e.add({id:188,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audioresample/",title:"AudioResample",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Info

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode
UInt32	sample count on success or errorcode on failure

Variants

AudioResample(input, outputSampleRate, output, capacity)

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode

AudioResample(input, outputSampleRate, output, capacity)

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	source buffer
outputSampleRate	UInt32	to samplerate
output	Single[]	target buffer
capacity	Int32	target capacity

Returns

Type	Description
UInt32	sample count on success or errorcode on failure

`}),e.add({id:189,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/audioresample/",title:"AudioResample",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Info

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode
UInt32	sample count on success or errorcode on failure

Variants

AudioResample(input, outputSampleRate, output, capacity)

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode

AudioResample(input, outputSampleRate, output, capacity)

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	source buffer
outputSampleRate	UInt32	to samplerate
output	Single[]	target buffer
capacity	Int32	target capacity

Returns

Type	Description
UInt32	sample count on success or errorcode on failure

`}),e.add({id:190,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audioresample/",title:"AudioResample",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Info

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode
UInt32	sample count on success or errorcode on failure

Variants

AudioResample(input, outputSampleRate, output, capacity)

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode

AudioResample(input, outputSampleRate, output, capacity)

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	source buffer
outputSampleRate	UInt32	to samplerate
output	Single[]	target buffer
capacity	Int32	target capacity

Returns

Type	Description
UInt32	sample count on success or errorcode on failure

`}),e.add({id:191,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audioresample/",title:"AudioResample",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)
public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Info

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode
UInt32	sample count on success or errorcode on failure

Variants

AudioResample(input, outputSampleRate, output, capacity)

public virtual bool AudioResample(float[] input, uint outputSampleRate, out float[] output, out int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	current buffer
outputSampleRate	UInt32	resample samplerate
output	Single[]	resampled buffer
capacity	Int32	size of resampled buffer

Returns

Type	Description
Boolean	true on success or false if missmatch of capacity i.e. errorcode

AudioResample(input, outputSampleRate, output, capacity)

public virtual uint AudioResample(float[] input, uint outputSampleRate, float[] output, int capacity)

Set a resampler and resamples a chunk of audio.

Warning

This is intended for situations where the audio output pipeline doesn't support 48kHz.

Parameters

Name	Type	Description
input	Single[]	source buffer
outputSampleRate	UInt32	to samplerate
output	Single[]	target buffer
capacity	Int32	target capacity

Returns

Type	Description
UInt32	sample count on success or errorcode on failure

`}),e.add({id:192,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public abstract bool AudioReset()

Returns

Type	Description
Boolean

`}),e.add({id:193,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

AudioReset is not supported!

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:194,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Returns

Type	Description
Boolean	True, if reset was successful

`}),e.add({id:195,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public abstract bool AudioReset()

Returns

Type	Description
Boolean

`}),e.add({id:196,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

AudioReset is not supported!

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:197,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Returns

Type	Description
Boolean	True, if reset was successful

`}),e.add({id:198,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public abstract bool AudioReset()

Returns

Type	Description
Boolean

`}),e.add({id:199,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

AudioReset is not supported!

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:200,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstream/audioreset/",title:"AudioReset",section:"ODIN Documentation",description:"",content:`

public override bool AudioReset()

This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Returns

Type	Description
Boolean	True, if reset was successful

`}),e.add({id:201,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

Retrieves statistics for the specified Media.

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:202,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public override bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

AudioReadData and AudioReadDataAsync are not supported!

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:203,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

Retrieves statistics for the specified Media.

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:204,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public override bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

AudioReadData and AudioReadDataAsync are not supported!

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:205,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public virtual bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

Retrieves statistics for the specified Media.

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:206,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"",content:`

public override bool AudioStats(out NativeBindings.OdinAudioStreamStats stats)

AudioReadData and AudioReadDataAsync are not supported!

Info

This will only work for remote/output streams.

Parameters

Name	Type	Description
stats	OdinAudioStreamStats	Audio stream statistics

Returns

Type	Description
Boolean	throws OdinWrapperException

`}),e.add({id:207,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinroomevents/audiostats/",title:"AudioStats",section:"ODIN Documentation",description:"Internal encoder/decoder stats updates.",content:`

OdinAudioStatsEvent

Internal encoder/decoder stats updates.

Value Type

Type	Description
Boolean

`}),e.add({id:209,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/autodestroyaudiosource/",title:"AutoDestroyAudioSource",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak (AudioSource) or false for manually manage sources ",content:`

public bool AutoDestroyAudioSource

On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources

Value Type

Type	Description
Boolean

`}),e.add({id:210,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/autodestroyaudiosource/",title:"AutoDestroyAudioSource",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak (AudioSource) or false for manually manage sources ",content:`

public bool AutoDestroyAudioSource

On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources

Value Type

Type	Description
Boolean

`}),e.add({id:211,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/autodestroyaudiosource/",title:"AutoDestroyAudioSource",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak (AudioSource) or false for manually manage sources ",content:`

public bool AutoDestroyAudioSource

On true destroy the PlaybackComponent in dispose to not leak (AudioSource) or false for manually manage sources

Value Type

Type	Description
Boolean

`}),e.add({id:212,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/autodestroyaudiosource/",title:"AutoDestroyAudioSource",section:"ODIN Documentation",description:" Flag for destroy linked AudioSource ",content:`

public bool AutoDestroyAudioSource

Flag for destroy Playback linked AudioSource

Value Type

Type	Description
Boolean

`}),e.add({id:213,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/autodestroyaudiosource/",title:"AutoDestroyAudioSource",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak (AudioSource) or false for manually manage sources ",content:`

public bool AutoDestroyAudioSource

On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources

Value Type

Type	Description
Boolean

`}),e.add({id:214,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak or false for manually manage stream ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool AutoDestroyMediaStream

On true destroy the Media in dispose to not leak or false for manually manage stream

Info

On room leave/destroy the underlying streams will still be freed up

Value Type

Type	Description
Boolean

`}),e.add({id:215,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak or false for manually manage stream ",content:`

public bool AutoDestroyMediaStream

On true destroy the Media in dispose to not leak or false for manually manage stream

Info

On room leave/destroy the underlying streams will still be freed up

Value Type

Type	Description
Boolean

`}),e.add({id:216,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak or false for manually manage stream ",content:`

public bool AutoDestroyMediaStream

On true destroy the Media in dispose to not leak or false for manually manage stream

Info

On room leave/destroy the underlying streams will still be freed up

Value Type

Type	Description
Boolean

`}),e.add({id:217,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak or false for manually manage stream ",content:`

public bool AutoDestroyMediaStream

On true destroy the Media in dispose to not leak or false for manually manage stream

Info

On room leave/destroy the underlying streams will still be freed up

Value Type

Type	Description
Boolean

`}),e.add({id:218,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" Flag for dispose of ",content:`

public bool AutoDestroyMediaStream

Flag for dispose of MediaDecoder

Info

This should only be set for unhandled or bound decoders

Value Type

Type	Description
Boolean

`}),e.add({id:219,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/autodestroymediastream/",title:"AutoDestroyMediaStream",section:"ODIN Documentation",description:" On true destroy the in dispose to not leak or false for manually manage stream ",content:`

public bool AutoDestroyMediaStream

On true destroy the Media in dispose to not leak or false for manually manage stream

Info

On room leave/destroy the underlying streams will still be freed up

Value Type

Type	Description
Boolean

`}),e.add({id:220,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use (Microphone.Start) in ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool AutostartListen

Use (Microphone.Start) in MicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:221,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use (Microphone.Start) in ",content:`

public bool AutostartListen

Use (Microphone.Start) in MicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:222,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use (Microphone.Start) in ",content:`

public bool AutostartListen

Use (Microphone.Start) in MicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:223,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use (Microphone.Start) in ",content:`

public bool AutostartListen

Use (Microphone.Start) in MicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:224,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use UnityEngine.Microphone.Start (Microphone.Start) in ",content:`

public bool AutostartListen

Use UnityEngine.Microphone.Start (Microphone.Start) in OdinMicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:225,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/autostartlisten/",title:"AutostartListen",section:"ODIN Documentation",description:" Use (Microphone.Start) in ",content:`

public bool AutostartListen

Use (Microphone.Start) in MicrophoneReader

Value Type

Type	Description
Boolean

`}),e.add({id:226,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/availableencoderids/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:227,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onconnectionstatuschanged/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:228,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/ondatagram/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:229,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onmediastarted/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:230,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onmediastopped/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:231,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onmessagereceived/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:232,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onpeerjoined/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:233,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onpeerleft/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:234,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onroomjoined/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:235,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onrpc/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:236,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onsendrpcresponse/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:237,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/onuserdatachanged/",title:"AvailableEncoderIds",section:"ODIN Documentation",description:" Available media ids that are reserved for the room ",content:`

public Queue<ushort> AvailableEncoderIds

Available media ids that are reserved for the room

Info

Contains a set of reserved ids that are free to use with input medias by the server.

Value Type

Type	Description
Queue<UInt16>

`}),e.add({id:238,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/bin16/",title:"Bin16",section:"ODIN Documentation",description:"",content:`

public const byte Bin16 = 197

Value Type

Type	Description
Byte

`}),e.add({id:239,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/bin32/",title:"Bin32",section:"ODIN Documentation",description:"",content:`

public const byte Bin32 = 198

Value Type

Type	Description
Byte

`}),e.add({id:240,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/bin8/",title:"Bin8",section:"ODIN Documentation",description:"",content:`

public const byte Bin8 = 196

Value Type

Type	Description
Byte

`}),e.add({id:241,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/nativebindings/blocksamplerate/",title:"BlockSamplerate",section:"ODIN Documentation",description:" Block_SAMPLE_RATE ",content:`

public const uint BlockSamplerate = 48000U

Block_SAMPLE_RATE

Value Type

Type	Description
UInt32

`}),e.add({id:242,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/nativebindings/blocksamplerate/",title:"BlockSamplerate",section:"ODIN Documentation",description:" Block_SAMPLE_RATE ",content:`

public const uint BlockSamplerate = 48000U

Block_SAMPLE_RATE

Value Type

Type	Description
UInt32

`}),e.add({id:243,href:"https://www.4players.io/odin/sdk/unity/classes/nativebindings/blocksamplerate/",title:"BlockSamplerate",section:"ODIN Documentation",description:" Block_SAMPLE_RATE ",content:`

public const uint BlockSamplerate = 48000U

Block_SAMPLE_RATE

Value Type

Type	Description
UInt32

`}),e.add({id:244,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void BroadcastMessage(byte[] data)

Sends arbitrary data to a all remote peers in all rooms

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array

`}),e.add({id:245,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool BroadcastMessage(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer id

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:246,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public void BroadcastMessage(byte[] data)

Sends arbitrary data to a all remote peers in all rooms

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array

`}),e.add({id:247,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public bool BroadcastMessage(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer id

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:248,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public void BroadcastMessage(byte[] data)

Sends arbitrary data to a all remote peers in all rooms

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array

`}),e.add({id:249,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public bool BroadcastMessage(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer id

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:250,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public void BroadcastMessage(byte[] data)

Sends arbitrary data to a all remote peers in all rooms

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array

`}),e.add({id:251,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public bool BroadcastMessage(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer id

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:252,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public void BroadcastMessage(byte[] data)

Sends arbitrary data to a all remote peers in all rooms

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array

`}),e.add({id:253,href:"https://www.4players.io/odin/sdk/unity/classes/room/broadcastmessage/",title:"BroadcastMessage",section:"ODIN Documentation",description:"",content:`

public bool BroadcastMessage(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer id

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:254,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/broadcastmessageasync/",title:"BroadcastMessageAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer get the message too

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:255,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/broadcastmessageasync/",title:"BroadcastMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer get the message too

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:256,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/broadcastmessageasync/",title:"BroadcastMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer get the message too

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:257,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/broadcastmessageasync/",title:"BroadcastMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer get the message too

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:258,href:"https://www.4players.io/odin/sdk/unity/classes/room/broadcastmessageasync/",title:"BroadcastMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> BroadcastMessageAsync(byte[] data, bool includeSelf = false)

Sends arbitrary data to a all remote peers in this room.

Parameters

Name	Type	Description
data	Byte[]	arbitrary byte array
includeSelf	Boolean	idicates whether this current peer get the message too

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:259,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/broadcastsendmessage/",title:"BroadcastSendMessage",section:"ODIN Documentation",description:"",content:`

public void BroadcastSendMessage(string message)

Send a message to all rooms with the default encoding UTF8

Parameters

Name	Type	Description
message	String	UTF8 string

`}),e.add({id:260,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:261,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:262,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:263,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:264,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:265,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/buffer/",title:"Buffer",section:"ODIN Documentation",description:" Raw UserData ",content:`

public byte[] Buffer { get; set; }

Raw UserData

Value Type

Type	Description
Byte[]

`}),e.add({id:266,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinrpc/bytes/",title:"bytes",section:"ODIN Documentation",description:" byte[] ",content:`

public IntPtr bytes

byte[]

Value Type

Type	Description
IntPtr

`}),e.add({id:267,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinrpc/bytes_length/",title:"bytes_length",section:"ODIN Documentation",description:"",content:`

public UInt32 bytes_length

Value Type

Type	Description
UInt32

`}),e.add({id:268,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/calculatermsdbfs/",title:"CalculateRmsDbfs",section:"ODIN Documentation",description:"",content:`

public double CalculateRmsDbfs()

Returns

Type	Description
Double

`}),e.add({id:269,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/cancel/",title:"Cancel",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Cancel()

Cancel the custom CancellationSource.

Returns

Type	Description
Boolean	true if the token was canceled or false

`}),e.add({id:270,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/cancel/",title:"Cancel",section:"ODIN Documentation",description:"",content:`

public bool Cancel()

Cancel the custom CancellationSource.

Returns

Type	Description
Boolean	true if the token was canceled or false

`}),e.add({id:271,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/cancel/",title:"Cancel",section:"ODIN Documentation",description:"",content:`

public bool Cancel()

Cancel the custom CancellationSource.

Returns

Type	Description
Boolean	true if the token was canceled or false

`}),e.add({id:272,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/cancel/",title:"Cancel",section:"ODIN Documentation",description:"",content:`

public bool Cancel()

Cancel the custom CancellationSource.

Returns

Type	Description
Boolean	true if the token was canceled or false

`}),e.add({id:273,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/cancel/",title:"Cancel",section:"ODIN Documentation",description:"",content:`

public bool Cancel()

Cancel the custom CancellationSource.

Returns

Type	Description
Boolean	true if the token was canceled or false

`}),e.add({id:274,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/cancellationsource/",title:"CancellationSource",section:"ODIN Documentation",description:" Control of async read and write tasks ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public CancellationTokenSource CancellationSource { get; }

Control of async read and write tasks

Value Type

Type	Description
CancellationTokenSource

`}),e.add({id:275,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/cancellationsource/",title:"CancellationSource",section:"ODIN Documentation",description:" Control of async read and write tasks ",content:`

public CancellationTokenSource CancellationSource { get; }

Control of async read and write tasks

Value Type

Type	Description
CancellationTokenSource

`}),e.add({id:276,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/cancellationsource/",title:"CancellationSource",section:"ODIN Documentation",description:" Control of async read and write tasks ",content:`

public CancellationTokenSource CancellationSource { get; }

Control of async read and write tasks

Value Type

Type	Description
CancellationTokenSource

`}),e.add({id:277,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/cancellationsource/",title:"CancellationSource",section:"ODIN Documentation",description:" Control of async read and write tasks ",content:`

public CancellationTokenSource CancellationSource { get; }

Control of async read and write tasks

Value Type

Type	Description
CancellationTokenSource

`}),e.add({id:278,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/cancellationsource/",title:"CancellationSource",section:"ODIN Documentation",description:" Control of async read and write tasks ",content:`

public CancellationTokenSource CancellationSource { get; }

Control of async read and write tasks

Value Type

Type	Description
CancellationTokenSource

`}),e.add({id:279,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/changemediastream/",title:"changeMediaStream",section:"ODIN Documentation",description:"Changes the active capture stream (e.g. when switching to another input device).",content:`

changeMediaStream(mediaStream: MediaStream): Promise<void>

Changes the active capture stream (e.g. when switching to another input device).

Parameters

Name	Type	Description
mediaStream	MediaStream	The capture stream of the input device

Returns

Type	Description
Promise<void>

`}),e.add({id:280,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/connectionstatechangedeventargs/changereason/",title:"ChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }

Reason of connection state

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:281,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/connectionstatechangedeventargs/changereason/",title:"ChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }

Reason of connection state

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:282,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/connectionstatechangedeventargs/changereason/",title:"ChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }

Reason of connection state

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:283,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/connectionstatechangedeventargs/changereason/",title:"ChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }

Reason of connection state

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:284,href:"https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedeventargs/changereason/",title:"ChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public NativeBindings.OdinRoomConnectionStateChangeReason ChangeReason { get; }

Reason of connection state

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:285,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/changevolume/",title:"changeVolume",section:"ODIN Documentation",description:"Changes the playback volume of the media.",content:`

changeVolume(volume: number): void

Changes the playback volume of the media.

Parameters

Name	Type	Description
volume	number	The new volume (Default is 1)

Returns

Type	Description
void

`}),e.add({id:286,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/changevolume/",title:"changeVolume",section:"ODIN Documentation",description:"Change the global master volume for the room (should be between 0 and 2).",content:`

changeVolume(volume: number): void

Change the global master volume for the room (should be between 0 and 2).

Parameters

Name	Type	Description
volume	number	The new volume

Returns

Type	Description
void

`}),e.add({id:287,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinmediaconfig/channels/",title:"Channels",section:"ODIN Documentation",description:" The number of audio channels ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaChannels Channels { get; set; }

The number of audio channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:288,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinmediaconfig/channels/",title:"Channels",section:"ODIN Documentation",description:" The number of audio channels ",content:`

public MediaChannels Channels { get; set; }

The number of audio channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:289,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinmediaconfig/channels/",title:"Channels",section:"ODIN Documentation",description:" The number of audio channels ",content:`

public MediaChannels Channels { get; set; }

The number of audio channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:290,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinmediaconfig/channels/",title:"Channels",section:"ODIN Documentation",description:" The number of audio channels ",content:`

public MediaChannels Channels { get; set; }

The number of audio channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:291,href:"https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig/channels/",title:"Channels",section:"ODIN Documentation",description:" The number of audio channels ",content:`

public MediaChannels Channels { get; set; }

The number of audio channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:292,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/checkresetframebuffer/",title:"CheckResetFrameBuffer",section:"ODIN Documentation",description:"",content:`

public virtual void CheckResetFrameBuffer(float audioBufferSize)

Parameters

Name	Type	Description
audioBufferSize	Single

`}),e.add({id:293,href:"https://www.4players.io/odin/sdk/nodejs/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all Classes available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Classes:

OdinClient

OdinMedia

OdinRoom

`}),e.add({id:294,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
OdinHandler
MicrophoneReader	Handles microphone input data and sends input to ODIN
PlaybackComponent	Handles the Playback for received ODIN audio data.
OdinBanner

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
NativeBindings	C# bindings for the native ODIN runtime
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaConfig	ODIN audio stream configuration
OdinRoomConfig	Audio processing configuration of an ODIN room
Utility
MediaCollection	Internal collection of available media streams
MediaStream	Base stream
MicrophoneStream	Representation of a write only audio stream
PlaybackStream	Representation of a read only audio stream
OdinClient	Client Wrapper for ODIN ffi OdinLibrary
OdinDefaults	ODIN default configuration
Peer	Client/Remote peer
PeerCollection	Intern peer dictionary
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
Room	Main Room
RoomCollection	Intern room dictionary
RoomConfig	A set of values that are used when creating Rooms
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
UserData	Odin UserData helper for marshal byte arrays
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)
OdinEditorConfig	UnityEditor UI component for instance config of Odin

`}),e.add({id:295,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
OdinHandler
MicrophoneReader	Handles microphone input data and sends input to ODIN
PlaybackComponent	Handles the Playback for received ODIN audio data.
PlaybackStats
OdinBanner
OdinEditorConfig	UnityEditor UI component for instance config of Odin

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
NativeBindings	C# bindings for the native ODIN runtime
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaConfig	ODIN audio stream configuration
OdinRoomConfig	Audio processing configuration of an ODIN room
Utility
MediaCollection	Internal collection of available media streams
MediaStream	Base stream
MicrophoneStream	Representation of a write only audio stream
PlaybackStream	Representation of a read only audio stream
OdinClient	Client Wrapper for ODIN ffi OdinLibrary
OdinDefaults	ODIN default configuration
Peer	Client/Remote peer
PeerCollection	Intern peer dictionary
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
Room	Main Room
RoomCollection	Intern room dictionary
RoomConfig	A set of values that are used when creating Rooms
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
UserData	Odin UserData helper for marshal byte arrays
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:296,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
OdinHandler
MicrophoneReader	Handles microphone input data and sends input to ODIN
PlaybackComponent	Handles the Playback for received ODIN audio data.
PlaybackStats
OdinBanner

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
NativeBindings	C# bindings for the native ODIN runtime
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaConfig	ODIN audio stream configuration
OdinRoomConfig	Audio processing configuration of an ODIN room
Utility
MediaCollection	Internal collection of available media streams
MediaStream	Base stream
MicrophoneStream	Representation of a write only audio stream
PlaybackStream	Representation of a read only audio stream
OdinClient	Client Wrapper for ODIN ffi OdinLibrary
OdinDefaults	ODIN default configuration
Peer	Client/Remote peer
PeerCollection	Intern peer dictionary
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
Room	Main Room
RoomCollection	Intern room dictionary
RoomConfig	A set of values that are used when creating Rooms
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
UserData	Odin UserData helper for marshal byte arrays
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)
OdinEditorConfig	UnityEditor UI component for instance config of Odin

`}),e.add({id:297,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
MicrophoneReader	Handles microphone input data and sends input to ODIN
OdinBanner
OdinEditorConfig	UnityEditor UI component for instance config of Odin
OdinHandler	The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes.
PlaybackComponent	Handles the Playback for received ODIN audio data.
PlaybackStats

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaCollection	Internal collection of available media streams
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaStream	Base stream
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MicrophoneStream	Representation of a write only audio stream
NativeBindings	C# bindings for the native ODIN runtime
OdinClient	Client Wrapper for ODIN ffi OdinLibrary
OdinDefaults	ODIN default configuration
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaConfig	ODIN audio stream configuration
OdinRoomConfig	Audio processing configuration of an ODIN room
Peer	Client/Remote peer
PeerCollection	Intern peer dictionary
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PlaybackStream	Representation of a read only audio stream
Room	Main Room
RoomCollection	Intern room dictionary
RoomConfig	A set of values that are used when creating Rooms
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)
UserData	Odin UserData helper for marshal byte arrays
Utility

`}),e.add({id:298,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
OdinApmComponent	AudioProcessingModule component for Media This class provides configuration for the native implemented audio processing. The supported processor/filter are applicable to Media which must be set.
OdinAudioReader	Handles audioclip input data and sends input to ODIN This convenient class gathers input audio data from Unity to pass the data with OdinAudioReader event to other components.
OdinBanner
OdinConnection	Wrapper class of Odin connections This convenient class provides dispatching of events to Unity with passthrough to support multiple rooms on fewer connections.
OdinCustomEffectUnityComponentBase	Custom base component for Media This convenient class provides effect template with a passthrough of custom userdata on a callback. The abstract representation of a base custom effect is to simplify implementation of Audio as a Unity component. (see other predefined custom effects)
OdinMedia	Wrapper class of Odin for Unity (require AudioSource) This convenient class provides predefined helper functions to cover for a default usecases where the voice chat needs to work with AudioSource, AudioClip, AudioMixer, … Default Unity GameObject altering functions: OdinMediaAdd OdinMuteAudioComponent to the current GameObject
OdinMicrophoneReader	Handles microphone input data and sends input to ODIN This convenient class gathers input audio data from Unity managed Microphone to pass the data with OdinMicrophoneReader event to other components.
OdinPeer	Wrapper class of Odin for Unity This convenient class provides dispatching of events to Unity with passthrough as well as predefined helper functions to cover for a default usecases where the voice chat is visually and logical represented Unity gameobject that are manageable with the Unity editor. Default Unity GameObject altering event callback functions: Unity component
OdinRoom	Wrapper class of Room for Unity. This convenient class provides dispatching of events to Unity with passthrough as well as predefined helper functions to cover for a default usecases where the voice chat is visually and logical represented Unity gameobject that are manageable with the Unity editor like Context menu, Inspector and/or Hierarchy window. Default Unity GameObject altering event callback functions: ConnectionStatusState(SystemDestroy this components GameObject if the connection is closed i.e cleanup
OdinVadComponent	VoiceActivity component for Media This class provides configuration for the native implemented voice detection. Supports speech recognition and/or a volume threshold.

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
ApmEffect	VoiceActivity effect for Odin
ArrayEnumerable
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
CustomEffect	Custom effect for Odin callbacks
DatagramEventArgs	Arguments for datagram events
DatagramProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MapEnumerable
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaDecoder	Odin Playback Media
MediaEncoder	Odin Capture Media
MediaPipeline	Odin audio pipeline
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaRpcProperties	arbitrary media data
MessagePackReaderException
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MsgPackToken	https://github.com/msgpack/msgpack/blob/master/spec.md
MsgPackWriter	Rudimentary Msgpack implementation that will be used for sending RPC to the server.
NativeBindings	C# bindings for the native ODIN runtime
Notification	Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
OdinAudioData
OdinAudioMediaCallbackMarshal
OdinAudioMediaMarshal
OdinCallbackAudioData
OdinClient	Client Wrapper for ODIN ffi `OdinNative.Core.OdinLibrary.NativeMethods`
OdinColliderFilterComponent	Custom filter by collider component for Media This class is a effect in the odin audio pipline to mute audio based on GameObject collisions in Unity space. The effect can help to trigger specific audio packets quickly without the adjustment of Server-side positions.
OdinConnectionPoolHandle
OdinDecoderHandle
OdinDefaults	ODIN default configuration
OdinEncoderHandle
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaData
OdinMuteAudioComponent	Custom mute audio component for Media This class is a effect in the odin audio pipline to mute based on the OdinMuteAudioComponent flag. The intention is to provide a convenient way with Unity Editor UI of Marshal a 1-byte signed integer bool for a specific audio packet in the current pipline.
OdinPipelineHandle
OdinRoomHandle
OdinTerrainFilterComponent	Custom filter by terrain component for Media This class is a effect in the odin audio pipline to mute audio based on location of a GameObject relative to a terrain type in Unity space. Note that the default implementation is Unity specific on a 2D calculation with X, Z and is not useful in all occlusions.
OdinTokenGeneratorHandle
OdinVolumeBoostComponent	Custom volume scale component for Media This class is a effect in the odin audio pipline to scale each sample individually in the buffer.
OdinVolumeComponent	Custom volume component for Media. Recommend the use of AudioSource.volume or AudioMixer/AudioMixerGroup instead This class is a effect in the odin audio pipline to change audio buffers by amplify the volume level.
PeerEntity	Client/Remote peer
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PiplineEffect
Request	Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
Response	Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
Room	Main Room
RoomCollection	Intern room dictionary
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
RpcEventArgs	Arguments for rpc events
RpcFormat	Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
RpcProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
RpcResult	Result of send rpc responses `msgid, (method, params, error, result)`
UnityAudioData
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)
UserData	Odin UserData helper for marshal byte arrays
Utility
VadEffect	VoiceActivity effect for Odin

`}),e.add({id:299,href:"https://www.4players.io/odin/sdk/unity/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all classes available in the ODIN Unity SDK",content:`

The Unity SDK consists of these classes:

Unity Components

You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.

Component	Description
MicrophoneReader	Handles microphone input data and sends input to ODIN
OdinBanner
OdinEditorConfig	UnityEditor UI component for instance config of Odin
OdinHandler	The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes.
PlaybackComponent	Handles the Playback for received ODIN audio data.
PlaybackStats

Utility Classes

Many of these classes are used internally or you rarely need to work with these.

Component	Description
ConnectionStateChangedEventArgs	Arguments for ConnectionStateChanged events in the current room
ConnectionStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaActiveStateChangedEventArgs	Arguments for MediaActiveStateChanged events in the current room
MediaActiveStateChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaAddedEventArgs	Arguments for MediaAdded events in the current room
MediaAddedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaCollection	Internal collection of available media streams
MediaRemovedEventArgs	Arguments for MediaRemoved events in the current room
MediaRemovedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MediaStream	Base stream
MessageReceivedEventArgs	Arguments for MessageReceived events in the current room
MessageReceivedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
MicrophoneStream	Representation of a write only audio stream
NativeBindings	C# bindings for the native ODIN runtime
OdinClient	Client Wrapper for ODIN ffi OdinLibrary
OdinDefaults	ODIN default configuration
OdinException	Exception type for the native ODIN runtime
OdinLibrary	Main lib entry class
OdinLibraryParameters	A set of values that are used when initializing the native ODIN runtime
OdinMediaConfig	ODIN audio stream configuration
OdinRoomConfig	Audio processing configuration of an ODIN room
Peer	Client/Remote peer
PeerCollection	Intern peer dictionary
PeerJoinedEventArgs	Arguments for PeerJoined events in the current room
PeerJoinedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerLeftEventArgs	Arguments for PeerLeft events in the current room
PeerLeftProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PeerUserDataChangedEventArgs	Arguments for PeerUserDataChanged events in the current room
PeerUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
PlaybackStream	Representation of a read only audio stream
Room	Main Room
RoomCollection	Intern room dictionary
RoomConfig	A set of values that are used when creating Rooms
RoomJoinEventArgs	Arguments for RoomJoin events right before the room is joined
RoomJoinProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomJoinedEventArgs	Arguments for RoomJoined events when the room was joined successfully
RoomJoinedProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeaveEventArgs	Arguments for RoomLeave events right before the room handle is destroyed
RoomLeaveProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomLeftEventArgs	Arguments for RoomLeft events when the room handle was destroyed
RoomLeftProxy	This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.
RoomUserDataChangedEventArgs	Arguments for RoomUserDataChanged events in the current room
RoomUserDataChangedProxy	This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)
UnityCreatedMediaObject
UnityDeleteMediaObject	Unity Inspector event wrapper (UnityEvent)
UserData	Odin UserData helper for marshal byte arrays
Utility

`}),e.add({id:300,href:"https://www.4players.io/odin/sdk/web/classes/",title:"Classes",section:"ODIN Documentation",description:"An index of all Classes available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Classes:

OdinClient

OdinMedia

OdinPeer

OdinRoom

`}),e.add({id:301,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/cleanupmanageddata/",title:"CleanUpManagedData",section:"ODIN Documentation",description:"",content:`

public void CleanUpManagedData(object managedObj)

Parameters

Name	Type	Description
managedObj	Object

`}),e.add({id:302,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/cleanupmanageddata/",title:"CleanUpManagedData",section:"ODIN Documentation",description:"",content:`

public void CleanUpManagedData(object managedObj)

Parameters

Name	Type	Description
managedObj	Object

`}),e.add({id:303,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/cleanupnativedata/",title:"CleanUpNativeData",section:"ODIN Documentation",description:"",content:`

public void CleanUpNativeData(IntPtr pNativeData)

Parameters

Name	Type	Description
pNativeData	IntPtr

`}),e.add({id:304,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/cleanupnativedata/",title:"CleanUpNativeData",section:"ODIN Documentation",description:"",content:`

public void CleanUpNativeData(IntPtr pNativeData)

Parameters

Name	Type	Description
pNativeData	IntPtr

`}),e.add({id:305,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Clear()

Free and empty the collection

`}),e.add({id:306,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Clear()

Free and empty the collection

`}),e.add({id:307,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Clear()

Free and empty the collection

`}),e.add({id:308,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:309,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:310,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:311,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:312,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:313,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:314,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:315,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:316,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:317,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Clear stream buffer

`}),e.add({id:318,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:319,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

void Clear()

`}),e.add({id:320,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:321,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:322,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/clear/",title:"Clear",section:"ODIN Documentation",description:"",content:`

public void Clear()

Free and empty the collection

`}),e.add({id:323,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/clientid/",title:"ClientId",section:"ODIN Documentation",description:" Odin Client ID ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string ClientId

Odin Client ID

Info

Room token userId

Value Type

Type	Description
String

`}),e.add({id:324,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/clientid/",title:"ClientId",section:"ODIN Documentation",description:" Odin Client ID ",content:`

public string ClientId

Odin Client ID

Info

Room token userId

Value Type

Type	Description
String

`}),e.add({id:325,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/clientid/",title:"ClientId",section:"ODIN Documentation",description:" Odin Client ID ",content:`

public string ClientId

Odin Client ID

Info

Room token userId

Value Type

Type	Description
String

`}),e.add({id:326,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/clientid/",title:"ClientId",section:"ODIN Documentation",description:" Odin Client ID ",content:`

public string ClientId

Odin Client ID

Info

Room token userId

Value Type

Type	Description
String

`}),e.add({id:327,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/clientid/",title:"ClientId",section:"ODIN Documentation",description:" Odin Client ID ",content:`

public string ClientId

Odin Client ID

Info

Room token userId

Value Type

Type	Description
String

`}),e.add({id:328,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstatechangereason/clientrequested/",title:"ClientRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the user ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

ClientRequested = 0

Connection state change was initiated by the user

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:329,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstatechangereason/clientrequested/",title:"ClientRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the user ",content:`

ClientRequested = 0

Connection state change was initiated by the user

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:330,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstatechangereason/clientrequested/",title:"ClientRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the user ",content:`

ClientRequested = 0

Connection state change was initiated by the user

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:331,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstatechangereason/clientrequested/",title:"ClientRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the user ",content:`

ClientRequested = 0

Connection state change was initiated by the user

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:332,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstatechangereason/clientrequested/",title:"ClientRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the user ",content:`

ClientRequested = 0

Connection state change was initiated by the user

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:333,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:334,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:335,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:336,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:337,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:338,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/clone/",title:"Clone",section:"ODIN Documentation",description:"",content:`

public virtual UserData Clone()

Creates a shallow copy of the Buffer

Returns

Type	Description
UserData	new instance

`}),e.add({id:339,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/close/",title:"close",section:"ODIN Documentation",description:"Closes the local audio stream and removed the media from the room",content:`

public close(): void

Closes the local audio stream and removed the media from the room

Returns

Type	Description
void

`}),e.add({id:340,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/close/",title:"close",section:"ODIN Documentation",description:"Closes the room and disconnects from the server.",content:`

public close(): void

Closes the room and disconnects from the server.

Returns

Type	Description
void

`}),e.add({id:341,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Close()

Completly closes this Client and all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:342,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public void Close()

Completly closes this Client and all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:343,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public void Close()

Completly closes this Client and all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:344,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public void Close()

Completly closes this Client and all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:345,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public void Close()

Close the native room. (native dispose)

`}),e.add({id:346,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public bool Close(Room room)
public bool Close(ulong id)

Close a room

Info

Will not remove the room from collection

Parameters

Name	Type	Description
room	Room	room
id	UInt64

Returns

Type	Description
Boolean	true if room to close found

Variants

Close(room)

public bool Close(Room room)

Close a room

Warning

Will not remove the room from collection

Parameters

Name	Type	Description
room	Room	room

Returns

Type	Description
Boolean	true if room to close found

Close(id)

public bool Close(ulong id)

Close a room

Parameters

Name	Type	Description
id	UInt64

Returns

Type	Description
Boolean	true if room to close found

`}),e.add({id:347,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/close/",title:"Close",section:"ODIN Documentation",description:"",content:`

public void Close()

Completly closes this Client and all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:348,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/closeroom/",title:"CloseRoom",section:"ODIN Documentation",description:"",content:`

public bool CloseRoom(ulong roomId)
public bool CloseRoom(Room room)

Close a room by Id

Parameters

Name	Type	Description
roomId	UInt64	room id
room	Room	room to close

Returns

Type	Description
Boolean	true on success or false

Variants

CloseRoom(roomId)

public bool CloseRoom(ulong roomId)

Close a room by Id

Parameters

Name	Type	Description
roomId	UInt64	room id

Returns

Type	Description
Boolean	true on success or false

CloseRoom(room)

public bool CloseRoom(Room room)

Close a room

Parameters

Name	Type	Description
room	Room	room to close

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:349,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/closerooms/",title:"CloseRooms",section:"ODIN Documentation",description:"",content:`

public void CloseRooms()

Completely closes all Room associated.

`}),e.add({id:350,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincolliderfiltercomponent/collidertag/",title:"ColliderTag",section:"ODIN Documentation",description:"",content:`

public string ColliderTag

Value Type

Type	Description
String

`}),e.add({id:351,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincolliderfiltercomponent/comparison/",title:"Comparison",section:"ODIN Documentation",description:"",content:`

public StringComparison Comparison

Value Type

Type	Description
StringComparison

`}),e.add({id:352,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/config/",title:"config",section:"ODIN Documentation",description:"Global settings for ODIN connections.",content:`

IOdinClientSettings

Global settings for ODIN connections.

Value Type

Type	Description
OdinEditorConfig

`}),e.add({id:354,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/config/",title:"Config",section:"ODIN Documentation",description:" Room configuration ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public readonly RoomConfig Config

Room configuration

Value Type

Type	Description
RoomConfig

`}),e.add({id:355,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/config/",title:"Config",section:"ODIN Documentation",description:" Static reference to the global ",content:`

public static OdinEditorConfig Config { get; }

Static reference to the global Unity

Info

Value Type

Type	Description
OdinEditorConfig

`}),e.add({id:356,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/config/",title:"Config",section:"ODIN Documentation",description:" Room configuration ",content:`

public readonly RoomConfig Config

Room configuration

Value Type

Type	Description
RoomConfig

`}),e.add({id:357,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/config/",title:"Config",section:"ODIN Documentation",description:" Static reference to the global ",content:`

public static OdinEditorConfig Config { get; }

Static reference to the global Unity

Info

Value Type

Type	Description
OdinEditorConfig

`}),e.add({id:358,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/config/",title:"Config",section:"ODIN Documentation",description:" Room configuration ",content:`

public readonly RoomConfig Config

Room configuration

Value Type

Type	Description
RoomConfig

`}),e.add({id:359,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/config/",title:"Config",section:"ODIN Documentation",description:" Static reference to the global ",content:`

public static OdinEditorConfig Config { get; }

Static reference to the global Unity

Info

Value Type

Type	Description
OdinEditorConfig

`}),e.add({id:360,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/config/",title:"Config",section:"ODIN Documentation",description:" Room configuration ",content:`

public readonly RoomConfig Config

Room configuration

Value Type

Type	Description
RoomConfig

`}),e.add({id:361,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/config/",title:"Config",section:"ODIN Documentation",description:" Audio processing configuration ",content:`

public OdinApmConfig Config

Audio processing configuration

Value Type

Type	Description
OdinApmConfig

`}),e.add({id:362,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/config/",title:"Config",section:"ODIN Documentation",description:" Intern voice activity configuration ",content:`

public OdinVadConfig Config

Intern voice activity configuration

Value Type

Type	Description
OdinVadConfig

`}),e.add({id:363,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/config/",title:"Config",section:"ODIN Documentation",description:" Static reference to the global ",content:`

public static OdinEditorConfig Config { get; }

Static reference to the global Unity

Info

Value Type

Type	Description
OdinEditorConfig

`}),e.add({id:364,href:"https://www.4players.io/odin/sdk/unity/classes/room/config/",title:"Config",section:"ODIN Documentation",description:" Room configuration ",content:`

public readonly RoomConfig Config

Room configuration

Value Type

Type	Description
RoomConfig

`}),e.add({id:365,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/congestion_events/",title:"congestion_events",section:"ODIN Documentation",description:" Congestion events on the connection ",content:`

public ulong congestion_events

Congestion events on the connection

Value Type

Type	Description
UInt64

`}),e.add({id:366,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/congestion_events/",title:"congestion_events",section:"ODIN Documentation",description:" Congestion events on the connection ",content:`

public ulong congestion_events

Congestion events on the connection

Value Type

Type	Description
UInt64

`}),e.add({id:367,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/congestion_events/",title:"congestion_events",section:"ODIN Documentation",description:" Congestion events on the connection ",content:`

public ulong congestion_events

Congestion events on the connection

Value Type

Type	Description
UInt64

`}),e.add({id:368,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstate/connected/",title:"Connected",section:"ODIN Documentation",description:" Connection is established ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Connected = 1

Connection is established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:369,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstate/connected/",title:"Connected",section:"ODIN Documentation",description:" Connection is established ",content:`

Connected = 1

Connection is established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:370,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstate/connected/",title:"Connected",section:"ODIN Documentation",description:" Connection is established ",content:`

Connected = 1

Connection is established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:371,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstate/connected/",title:"Connected",section:"ODIN Documentation",description:" Connection is established ",content:`

Connected = 1

Connection is established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:372,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstate/connected/",title:"Connected",section:"ODIN Documentation",description:" Connection is established ",content:`

Connected = 1

Connection is established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:373,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstate/connecting/",title:"Connecting",section:"ODIN Documentation",description:" Connection is being established ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Connecting = 0

Connection is being established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:374,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstate/connecting/",title:"Connecting",section:"ODIN Documentation",description:" Connection is being established ",content:`

Connecting = 0

Connection is being established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:375,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstate/connecting/",title:"Connecting",section:"ODIN Documentation",description:" Connection is being established ",content:`

Connecting = 0

Connection is being established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:376,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstate/connecting/",title:"Connecting",section:"ODIN Documentation",description:" Connection is being established ",content:`

Connecting = 0

Connection is being established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:377,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstate/connecting/",title:"Connecting",section:"ODIN Documentation",description:" Connection is being established ",content:`

Connecting = 0

Connection is being established

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:378,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstatechangereason/connectionlost/",title:"ConnectionLost",section:"ODIN Documentation",description:" Connection state change was caused by a timeout ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

ConnectionLost = 2

Connection state change was caused by a timeout

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:379,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstatechangereason/connectionlost/",title:"ConnectionLost",section:"ODIN Documentation",description:" Connection state change was caused by a timeout ",content:`

ConnectionLost = 2

Connection state change was caused by a timeout

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:380,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstatechangereason/connectionlost/",title:"ConnectionLost",section:"ODIN Documentation",description:" Connection state change was caused by a timeout ",content:`

ConnectionLost = 2

Connection state change was caused by a timeout

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:381,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstatechangereason/connectionlost/",title:"ConnectionLost",section:"ODIN Documentation",description:" Connection state change was caused by a timeout ",content:`

ConnectionLost = 2

Connection state change was caused by a timeout

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:382,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstatechangereason/connectionlost/",title:"ConnectionLost",section:"ODIN Documentation",description:" Connection state change was caused by a timeout ",content:`

ConnectionLost = 2

Connection state change was caused by a timeout

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:383,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/connectionretry/",title:"ConnectionRetry",section:"ODIN Documentation",description:" The count of ConnectionState retry for reconnects. Reset on Connected ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int ConnectionRetry { get; }

The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected

Value Type

Type	Description
Int32

`}),e.add({id:384,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/connectionretry/",title:"ConnectionRetry",section:"ODIN Documentation",description:" The count of ConnectionState retry for reconnects. Reset on Connected ",content:`

public int ConnectionRetry { get; }

The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected

Value Type

Type	Description
Int32

`}),e.add({id:385,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/connectionretry/",title:"ConnectionRetry",section:"ODIN Documentation",description:" The count of ConnectionState retry for reconnects. Reset on Connected ",content:`

public int ConnectionRetry { get; }

The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected

Value Type

Type	Description
Int32

`}),e.add({id:386,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/connectionretry/",title:"ConnectionRetry",section:"ODIN Documentation",description:" The count of ConnectionState retry for reconnects. Reset on Connected ",content:`

public int ConnectionRetry { get; }

The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected

Value Type

Type	Description
Int32

`}),e.add({id:387,href:"https://www.4players.io/odin/sdk/unity/classes/room/connectionretry/",title:"ConnectionRetry",section:"ODIN Documentation",description:" The count of ConnectionState retry for reconnects. Reset on Connected ",content:`

public int ConnectionRetry { get; }

The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected

Value Type

Type	Description
Int32

`}),e.add({id:388,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/connectionstate/",title:"connectionState",section:"ODIN Documentation",description:"The current state of the main stream connection.",content:`

OdinConnectionState

The current state of the main stream connection.

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:391,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:392,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/connectionstatechangedeventargs/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public NativeBindings.OdinRoomConnectionState ConnectionState { get; }

Connection state of the ODIN client

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:393,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:394,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/connectionstatechangedeventargs/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public NativeBindings.OdinRoomConnectionState ConnectionState { get; }

Connection state of the ODIN client

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:395,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:396,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/connectionstatechangedeventargs/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public NativeBindings.OdinRoomConnectionState ConnectionState { get; }

Connection state of the ODIN client

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:397,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:398,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onconnectionstatechanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:399,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onmediaactivestatechanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:400,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onmediaadded/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:401,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onmediaremoved/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:402,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onmessagereceived/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:403,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onpeerjoined/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:404,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onpeerleft/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:405,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onpeeruserdatachanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:406,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/onroomuserdatachanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:407,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/connectionstatechangedeventargs/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public string ConnectionState { get; }

Connection state of the ODIN client

Value Type

Type	Description
String

`}),e.add({id:408,href:"https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedeventargs/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public NativeBindings.OdinRoomConnectionState ConnectionState { get; }

Connection state of the ODIN client

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:409,href:"https://www.4players.io/odin/sdk/unity/classes/room/connectionstate/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:410,href:"https://www.4players.io/odin/sdk/unity/classes/room/onconnectionstatechanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:411,href:"https://www.4players.io/odin/sdk/unity/classes/room/onmediaactivestatechanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:412,href:"https://www.4players.io/odin/sdk/unity/classes/room/onmediaadded/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:413,href:"https://www.4players.io/odin/sdk/unity/classes/room/onmediaremoved/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:414,href:"https://www.4players.io/odin/sdk/unity/classes/room/onmessagereceived/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:415,href:"https://www.4players.io/odin/sdk/unity/classes/room/onpeerjoined/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:416,href:"https://www.4players.io/odin/sdk/unity/classes/room/onpeerleft/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:417,href:"https://www.4players.io/odin/sdk/unity/classes/room/onpeeruserdatachanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:418,href:"https://www.4players.io/odin/sdk/unity/classes/room/onroomuserdatachanged/",title:"ConnectionState",section:"ODIN Documentation",description:" ConnectionState of the Room that is set by ODIN ",content:`

public static KeyValuePair<OdinRoomConnectionState, OdinRoomConnectionStateChangeReason> ConnectionState { get; }

ConnectionState of the Room that is set by ODIN

Value Type

Type	Description
KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>

`}),e.add({id:419,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/connectionstatechanged/",title:"ConnectionStateChanged",section:"ODIN Documentation",description:"Fired when the connection state of the room changed.",content:`

public ConnectionStateChanged: OdinConnectionStateChangedEvent

Fired when the connection state of the room changed.

Properties

Name	Type	Description
ConnectionState	OdinRoomConnectionState	Connection state of the ODIN client
ChangeReason	OdinRoomConnectionStateChangeReason	Reason of connection state
Retry	Int32	Connection retry count

`}),e.add({id:423,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/connectionstatechangedeventargs/",title:"ConnectionStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for ConnectionStateChanged events in the current room ",content:`

Inherits from:

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Type	Description
ConnectionState	OdinRoomConnectionState	Connection state of the ODIN client
ChangeReason	OdinRoomConnectionStateChangeReason	Reason of connection state
Retry	Int32	Connection retry count

`}),e.add({id:424,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/connectionstatechangedeventargs/",title:"ConnectionStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for ConnectionStateChanged events in the current room ",content:`

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Type	Description
ConnectionState	OdinRoomConnectionState	Connection state of the ODIN client
ChangeReason	OdinRoomConnectionStateChangeReason	Reason of connection state
Retry	Int32	Connection retry count

`}),e.add({id:425,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/connectionstatechangedeventargs/",title:"ConnectionStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for ConnectionStateChanged events in the current room ",content:`

Inherits from:

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Description
ConnectionState	Connection state of the ODIN client
ChangeReason	Reason of connection state
Retry	Connection retry count

`}),e.add({id:426,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/connectionstatechangedeventargs/",title:"ConnectionStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for ConnectionStateChanged events in the current room ",content:`

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Description
ConnectionState	Connection state of the ODIN client

`}),e.add({id:427,href:"https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedeventargs/",title:"ConnectionStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for ConnectionStateChanged events in the current room ",content:`

Inherits from:

public class ConnectionStateChangedEventArgs : EventArgs

Arguments for ConnectionStateChanged events in the current room

Properties

Name	Description
ConnectionState	Connection state of the ODIN client
ChangeReason	Reason of connection state
Retry	Connection retry count

`}),e.add({id:428,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:429,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:430,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:431,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:432,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:433,href:"https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedproxy/",title:"ConnectionStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class ConnectionStateChangedProxy : UnityEvent<object, ConnectionStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:434,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/connectionstatus/",title:"ConnectionStatus",section:"ODIN Documentation",description:" RoomStatus ",content:`

public string ConnectionStatus { get; }

RoomStatus

Value Type

Type	Description
String

`}),e.add({id:435,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/connectionstatusstate/",title:"ConnectionStatusState",section:"ODIN Documentation",description:"",content:`

public virtual void ConnectionStatusState(object sender, ConnectionStateChangedEventArgs status)

Check status if the room should destroy the gameobject

Info

Any room can not recover from a "Closed" state and will destroy the gameobject.

Parameters

Name	Type	Description
sender	Object	OdinRoom object
status	ConnectionStateChangedEventArgs	new status

`}),e.add({id:436,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/constructor/",title:"constructor",section:"ODIN Documentation",description:"Creates a new instance of a client. Use this to create rooms.",content:`

var odinclient = new OdinClient(sampleRate?: number, channelCount?: number)

Creates a new instance of a client. Use this to create rooms.

Parameters

Name	Type	Description
sampleRate	number	The sample rate of the audio stream (between 8000 and 48000) - default is 48000
channelCount	number	The number of channels of the audio stream (1 or 2) - default is 1

Parameters

Name	Type	Description
room	OdinRoom	The room to add the media to.
sampleRate	number	The sample rate of the audio stream (between 8000 and 48000)
channelCount	number	The number of channels of the audio stream (1 or 2)
options	OdinAPMSettings	Optional configuration options for Odin Audio Processing Module (APM).

Parameters

Name	Type	Description
token	string	The token to use for this room.

Parameters

Name	Type	Description
id	Int64	handle id of the stream
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(long id)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(MediaStream item)

Determines whether the media is in the collection

Parameters

Name	Type	Description
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:440,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Contains(ulong id)
public bool Contains(Peer item)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(ulong id)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Peer item)

Determines whether the peer is in the collection

Parameters

Name	Type	Description
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:441,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Contains(string key)
public bool Contains(Room item)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room
item	Room	room

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(key)

public bool Contains(string key)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:442,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:443,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(long id)
public bool Contains(MediaStream item)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(long id)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(MediaStream item)

Determines whether the media is in the collection

Parameters

Name	Type	Description
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:444,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(ulong id)
public bool Contains(Peer item)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(ulong id)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Peer item)

Determines whether the peer is in the collection

Parameters

Name	Type	Description
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:445,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(string key)
public bool Contains(Room item)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room
item	Room	room

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(key)

public bool Contains(string key)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:446,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:447,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(long id)
public bool Contains(MediaStream item)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(long id)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(MediaStream item)

Determines whether the media is in the collection

Parameters

Name	Type	Description
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:448,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(ulong id)
public bool Contains(Peer item)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(ulong id)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Peer item)

Determines whether the peer is in the collection

Parameters

Name	Type	Description
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:449,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(string key)
public bool Contains(Room item)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room
item	Room	room

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(key)

public bool Contains(string key)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:450,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:451,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(long id)
public bool Contains(MediaStream item)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(long id)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(MediaStream item)

Determines whether the media is in the collection

Parameters

Name	Type	Description
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:452,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(ulong id)
public bool Contains(Peer item)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(ulong id)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Peer item)

Determines whether the peer is in the collection

Parameters

Name	Type	Description
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:453,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(string key)
public bool Contains(Room item)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room
item	Room	room

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(key)

public bool Contains(string key)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:454,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:455,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:456,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:457,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(long id)
public bool Contains(MediaStream item)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(long id)

Determines whether the stream by id is in the collection

Parameters

Name	Type	Description
id	Int64	handle id of the stream

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(MediaStream item)

Determines whether the media is in the collection

Parameters

Name	Type	Description
item	MediaStream	stream

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:458,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(ulong id)
public bool Contains(Peer item)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(id)

public bool Contains(ulong id)

Determines whether the peer by id is in the collection

Parameters

Name	Type	Description
id	UInt64	peer id of the peer

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Peer item)

Determines whether the peer is in the collection

Parameters

Name	Type	Description
item	Peer	peer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:459,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public bool Contains(string key)
public bool Contains(Room item)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room
item	Room	room

Returns

Type	Description
Boolean	true on success or false

Variants

Contains(key)

public bool Contains(string key)

Determines whether the room by name/token is in the collection

Parameters

Name	Type	Description
key	String	room key of the room

Returns

Type	Description
Boolean	true on success or false

Contains(item)

public bool Contains(Room item)

Determines whether the room is in the collection

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:460,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/contains/",title:"Contains",section:"ODIN Documentation",description:"",content:`

public virtual bool Contains(string value)
public virtual bool Contains(byte value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

Variants

Contains(value)

public virtual bool Contains(string value)

Indicates whether substring occurs

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Boolean	true if contain

Contains(value)

public virtual bool Contains(byte value)

Indicates whether element occurs

Parameters

Name	Type	Description
value	Byte	byte

Returns

Type	Description
Boolean	true if contain

`}),e.add({id:461,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:462,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:463,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:464,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:465,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:466,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:467,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/continuerecording/",title:"ContinueRecording",section:"ODIN Documentation",description:"",content:`

public bool ContinueRecording

Value Type

Type	Description
Boolean

`}),e.add({id:468,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/copyframe/",title:"CopyFrame",section:"ODIN Documentation",description:"",content:`

public float[] CopyFrame()
public void CopyFrame(ref float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]

Returns

Type	Description
Single[]

Variants

CopyFrame()

public float[] CopyFrame()

Returns

Type	Description
Single[]

CopyFrame(buffer)

public void CopyFrame(ref float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:469,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:470,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:471,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:472,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:473,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public void CopyFrom(float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:474,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:475,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/copyfrom/",title:"CopyFrom",section:"ODIN Documentation",description:"",content:`

public virtual void CopyFrom(IntPtr ptr, ulong size)

Copies data from memory to Buffer

Parameters

Name	Type	Description
ptr	IntPtr	source
size	UInt64	Buffer size

`}),e.add({id:476,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void CopyTo(MediaStream[] array, int arrayIndex)

Copies stream of the collection to an array

Parameters

Name	Type	Description
array	MediaStream[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:477,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void CopyTo(Peer[] array, int arrayIndex)

Copies peers of the collection to an array

Parameters

Name	Type	Description
array	Peer[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:478,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void CopyTo(Room[] array, int arrayIndex)

Copies rooms of the collection to an array

Parameters

Name	Type	Description
array	Room[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:479,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(MediaStream[] array, int arrayIndex)

Copies stream of the collection to an array

Parameters

Name	Type	Description
array	MediaStream[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:480,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Peer[] array, int arrayIndex)

Copies peers of the collection to an array

Parameters

Name	Type	Description
array	Peer[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:481,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Room[] array, int arrayIndex)

Copies rooms of the collection to an array

Parameters

Name	Type	Description
array	Room[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:482,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(MediaStream[] array, int arrayIndex)

Copies stream of the collection to an array

Parameters

Name	Type	Description
array	MediaStream[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:483,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Peer[] array, int arrayIndex)

Copies peers of the collection to an array

Parameters

Name	Type	Description
array	Peer[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:484,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Room[] array, int arrayIndex)

Copies rooms of the collection to an array

Parameters

Name	Type	Description
array	Room[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:485,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(MediaStream[] array, int arrayIndex)

Copies stream of the collection to an array

Parameters

Name	Type	Description
array	MediaStream[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:486,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Peer[] array, int arrayIndex)

Copies peers of the collection to an array

Parameters

Name	Type	Description
array	Peer[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:487,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Room[] array, int arrayIndex)

Copies rooms of the collection to an array

Parameters

Name	Type	Description
array	Room[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:488,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(ref float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]

`}),e.add({id:489,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(MediaStream[] array, int arrayIndex)

Copies stream of the collection to an array

Parameters

Name	Type	Description
array	MediaStream[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:490,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Peer[] array, int arrayIndex)

Copies peers of the collection to an array

Parameters

Name	Type	Description
array	Peer[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:491,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/copyto/",title:"CopyTo",section:"ODIN Documentation",description:"",content:`

public void CopyTo(Room[] array, int arrayIndex)

Copies rooms of the collection to an array

Parameters

Name	Type	Description
array	Room[]	target array
arrayIndex	Int32	array offset

`}),e.add({id:492,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of streams in the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int Count { get; }

Count of streams in the collection

Value Type

Type	Description
Int32

`}),e.add({id:493,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of peers in the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int Count { get; }

Count of peers in the collection

Value Type

Type	Description
Int32

`}),e.add({id:494,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:495,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of streams in the collection ",content:`

public int Count { get; }

Count of streams in the collection

Value Type

Type	Description
Int32

`}),e.add({id:496,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of peers in the collection ",content:`

public int Count { get; }

Count of peers in the collection

Value Type

Type	Description
Int32

`}),e.add({id:497,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:498,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of streams in the collection ",content:`

public int Count { get; }

Count of streams in the collection

Value Type

Type	Description
Int32

`}),e.add({id:499,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of peers in the collection ",content:`

public int Count { get; }

Count of peers in the collection

Value Type

Type	Description
Int32

`}),e.add({id:500,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:501,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of streams in the collection ",content:`

public int Count { get; }

Count of streams in the collection

Value Type

Type	Description
Int32

`}),e.add({id:502,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of peers in the collection ",content:`

public int Count { get; }

Count of peers in the collection

Value Type

Type	Description
Int32

`}),e.add({id:503,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:504,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:505,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of streams in the collection ",content:`

public int Count { get; }

Count of streams in the collection

Value Type

Type	Description
Int32

`}),e.add({id:506,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of peers in the collection ",content:`

public int Count { get; }

Count of peers in the collection

Value Type

Type	Description
Int32

`}),e.add({id:507,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/count/",title:"Count",section:"ODIN Documentation",description:" Count of rooms in the collection ",content:`

public int Count { get; }

Count of rooms in the collection

Value Type

Type	Description
Int32

`}),e.add({id:508,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static ApmEffect Create(MediaPipeline pipeline, uint samplerate, bool stereo, OdinApmConfig config)

Insert a apm effect in the specified pipline and sets the apm config

Parameters

Name	Type	Description
pipeline	MediaPipeline	where to create a apm effect
samplerate	UInt32	samplerate of playback
stereo	Boolean	stereo of playback
config	OdinApmConfig	configuration settings for apm

Returns

Type	Description
ApmEffect	Instance of

`}),e.add({id:509,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static CustomEffect<T> Create(MediaPipeline pipeline, Action<OdinCallbackAudioData, T> callback, T userData)

Insert a custom effect in the specified pipline

Parameters

Name	Type	Description
pipeline	MediaPipeline	where to create a vad effect
callback	Action<OdinCallbackAudioData,<T>>	delegate reference for effect event
userData	<T>	custom userdata Marshal.StructureToPtr

Returns

Type	Description
CustomEffect	Instance of

`}),e.add({id:510,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static MediaDecoder Create(ushort mediaId, uint samplerate, bool stereo)

Create a new dangling output media.

Info

Is not automatically assigned to a managed room yet but exists in a specific native room only.

Parameters

Name	Type	Description
mediaId	UInt16	output media id
samplerate	UInt32	samplerate
stereo	Boolean	stereo flag

Returns

Type	Description
MediaDecoder	output media

`}),e.add({id:511,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static MediaEncoder Create(ushort mediaId, uint samplerate, bool stereo)

Create a new dangling input media.

Info

Is not automatically assigned to a managed room yet but exists in a specific native room only.

Parameters

Name	Type	Description
mediaId	UInt16	input media id
samplerate	UInt32	samplerate
stereo	Boolean	stereo flag

Returns

Type	Description
MediaEncoder	input media

`}),e.add({id:512,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static MsgPackWriter Create(byte[] bytes)
public static MsgPackWriter Create(byte[] bytes, Encoding encoding)

Create writer with a prefilled stream buffer

Parameters

Name	Type	Description
bytes	Byte[]	data that will be pushed into the stream
encoding	Encoding

Returns

Type	Description
MsgPackWriter	writer

Variants

Create(bytes)

public static MsgPackWriter Create(byte[] bytes)

Create writer with a prefilled stream buffer

Parameters

Name	Type	Description
bytes	Byte[]	data that will be pushed into the stream

Returns

Type	Description
MsgPackWriter	writer

Create(bytes, encoding)

public static MsgPackWriter Create(byte[] bytes, Encoding encoding)

Parameters

Name	Type	Description
bytes	Byte[]
encoding	Encoding

Returns

Type	Description
MsgPackWriter

`}),e.add({id:513,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static OdinClient Create(Uri server)
public static OdinClient Create(Uri server, string accessKey)
public static OdinClient Create(Uri server, string accessKey, NativeBindings.OdinConnectionPoolSettings settings)

Creates a new initialized instance for ODIN ffi C# Wrapper

Info

Will set a random accesskey; Can fail on initialize!

Parameters

Name	Type	Description
server	Uri	Odin Server/Gateway
accessKey	String	Odin access key
settings	OdinConnectionPoolSettings	Custom settings

Returns

Type	Description
OdinClient	OdinClient wrapper

Variants

Create(server)

public static OdinClient Create(Uri server)

Creates a new initialized instance for ODIN ffi C# Wrapper

Warning

Will set a random accesskey; Can fail on initialize!

Parameters

Name	Type	Description
server	Uri	Odin Server/Gateway

Returns

Type	Description
OdinClient	OdinClient wrapper

Create(server, accessKey)

public static OdinClient Create(Uri server, string accessKey)

Creates a new initialized instance for ODIN ffi C# Wrapper

Warning

Can fail on initialize!

Parameters

Name	Type	Description
server	Uri	Odin Server
accessKey	String	Odin access key

Returns

Type	Description
OdinClient	OdinClient wrapper

Create(server, accessKey, settings)

public static OdinClient Create(Uri server, string accessKey, NativeBindings.OdinConnectionPoolSettings settings)

Creates a new initialized instance for ODIN ffi C# Wrapper

Warning

Can fail on initialize!

Parameters

Name	Type	Description
server	Uri	Odin Server
accessKey	String	Odin access key
settings	OdinConnectionPoolSettings	Custom settings

Returns

Type	Description
OdinClient	OdinClient wrapper

`}),e.add({id:514,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static NativeBindings.OdinMediaData Create(uint size)
public static NativeBindings.OdinMediaData Create(float[] samples)

Parameters

Name	Type	Description
size	UInt32
samples	Single[]

Returns

Type	Description
OdinMediaData

Variants

Create(size)

public static NativeBindings.OdinMediaData Create(uint size)

Parameters

Name	Type	Description
size	UInt32

Returns

Type	Description
OdinMediaData

Create(samples)

public static NativeBindings.OdinMediaData Create(float[] samples)

Parameters

Name	Type	Description
samples	Single[]

Returns

Type	Description
OdinMediaData

`}),e.add({id:515,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static Room Create(string endPoint, uint samplerate, bool stereo)

Initialise independent room

Parameters

Name	Type	Description
endPoint	String	Gateway server
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag

Returns

Type	Description
Room	Room object

`}),e.add({id:516,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static bool Create(MediaPipeline pipeline, out VadEffect vad)
public static VadEffect Create(MediaPipeline pipeline, OdinVadConfig config)

Insert a vad effect in the specified pipline

Parameters

Name	Type	Description
pipeline	MediaPipeline	where to create a vad effect
vad	VadEffect
config	OdinVadConfig	configuration settings for vad

Returns

Type	Description
Boolean	Instance of
VadEffect	Instance of

Variants

Create(pipeline, vad)

public static bool Create(MediaPipeline pipeline, out VadEffect vad)

Insert a vad effect in the specified pipline

Parameters

Name	Type	Description
pipeline	MediaPipeline	where to create a vad effect
vad	VadEffect

Returns

Type	Description
Boolean	Instance of

Create(pipeline, config)

public static VadEffect Create(MediaPipeline pipeline, OdinVadConfig config)

Insert a vad effect in the specified pipline and sets the vad config

Parameters

Name	Type	Description
pipeline	MediaPipeline	where to create a vad effect
config	OdinVadConfig	configuration settings for vad

Returns

Type	Description
VadEffect	Instance of

`}),e.add({id:517,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/create/",title:"Create",section:"ODIN Documentation",description:"",content:`

public static MsgPackReader Create(byte[] data)

Parameters

Name	Type	Description
data	Byte[]

Returns

Type	Description
MsgPackReader

`}),e.add({id:518,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/createaccesskey/",title:"CreateAccessKey",section:"ODIN Documentation",description:"",content:`

public static string CreateAccessKey()

Create a example access key that can be registered on 4Players (see https://developers.4players.io/odin/)

Info

This is for testing and not intended for production. Access key should never be client side.

Returns

Type	Description
String	access key string or empty

`}),e.add({id:519,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/createaudiostream/",title:"createAudioStream",section:"ODIN Documentation",description:"Creates a local audio stream and adds it to the room. An OdinMedia object will be returned that allows you to send audio data.",content:`

public createAudioStream(sampleRate: number, channels: number, apmSettings?: OdinAPMSettings): OdinMedia

Creates a local audio stream and adds it to the room. An OdinMedia object will be returned that allows you to send audio data.

Parameters

Name	Type	Description
sampleRate	number	The sample rate of the audio stream. Can be between 8000 and 48000.
channels	number	The number of channels of the audio stream. Can be 1 or 2.
apmSettings	OdinAPMSettings

Returns

Type	Description
OdinMedia

`}),e.add({id:520,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/createdecoder/",title:"CreateDecoder",section:"ODIN Documentation",description:"",content:`

public MediaDecoder CreateDecoder(ushort mediaId, uint samplerate, bool stereo)

Create a new output media that will be added to PeerEntity

Parameters

Name	Type	Description
mediaId	UInt16	decoder id
samplerate	UInt32	samplerate
stereo	Boolean	stereo flag

Returns

Type	Description
MediaDecoder	output media

`}),e.add({id:521,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/createdecoder/",title:"CreateDecoder",section:"ODIN Documentation",description:"",content:`

public MediaDecoder CreateDecoder(ulong peerId, ushort mediaId)
public MediaDecoder CreateDecoder(ulong peerId, ushort mediaId, uint samplerate, bool stereo)

Create a new output media that will be added to PeerEntity

Info

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
MediaDecoder	output media

Variants

CreateDecoder(peerId, mediaId)

public MediaDecoder CreateDecoder(ulong peerId, ushort mediaId)

Create a new output media that will be added to PeerEntity

Warning

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media

Returns

Type	Description
MediaDecoder	output media

CreateDecoder(peerId, mediaId, samplerate, stereo)

public MediaDecoder CreateDecoder(ulong peerId, ushort mediaId, uint samplerate, bool stereo)

Create a new output media that will be added to PeerEntity

Warning

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
MediaDecoder	output media

`}),e.add({id:522,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/createencoder/",title:"CreateEncoder",section:"ODIN Documentation",description:"",content:`

public MediaEncoder CreateEncoder(ushort mediaId)
public MediaEncoder CreateEncoder(ushort mediaId, uint samplerate, bool stereo)

Create a new input media that will be added toRoom

Info

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
MediaEncoder	input media

Variants

CreateEncoder(mediaId)

public MediaEncoder CreateEncoder(ushort mediaId)

Create a new input media that will be added toRoom

Warning

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media

Returns

Type	Description
MediaEncoder	input media

CreateEncoder(mediaId, samplerate, stereo)

public MediaEncoder CreateEncoder(ushort mediaId, uint samplerate, bool stereo)

Create a new input media that will be added toRoom

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
MediaEncoder	input media

`}),e.add({id:523,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/createmedia/",title:"createMedia",section:"ODIN Documentation",description:"Creates a local media, configures audio capture/playback and returns the new `OdinMedia` instance.",content:`

createMedia(): OdinMedia

Creates a local media, configures audio capture/playback and returns the new OdinMedia instance.

Returns

Type	Description
OdinMedia

`}),e.add({id:524,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/createmedia/",title:"createMedia",section:"ODIN Documentation",description:"Creates a new local media using the specified stream.",content:`

createMedia(mediaStream: MediaStream, audioSettings?: IOdinAudioSettings): Promise<OdinMedia>

Creates a new local media using the specified stream.

Parameters

Name	Type	Description
mediaStream	MediaStream	The capture stream of the input device
audioSettings	IOdinAudioSettings	Optional audio settings like VAD or master volume used to initialize audio

Returns

Type	Description
Promise<OdinMedia>

`}),e.add({id:525,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/createmicrophonemedia/",title:"CreateMicrophoneMedia",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool CreateMicrophoneMedia(OdinMediaConfig config)

Try to add a MicrophoneMedia

Parameters

Name	Type	Description
config	OdinMediaConfig	Microphone device configuration

Returns

Type	Description
Boolean	true if media was added to the room or false

`}),e.add({id:526,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/createmicrophonemedia/",title:"CreateMicrophoneMedia",section:"ODIN Documentation",description:"",content:`

public bool CreateMicrophoneMedia(OdinMediaConfig config)

Try to add a MicrophoneMedia

Parameters

Name	Type	Description
config	OdinMediaConfig	Microphone device configuration

Returns

Type	Description
Boolean	true if media was added to the room or false

`}),e.add({id:527,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/createmicrophonemedia/",title:"CreateMicrophoneMedia",section:"ODIN Documentation",description:"",content:`

public bool CreateMicrophoneMedia(OdinMediaConfig config)

Try to add a MicrophoneMedia

Parameters

Name	Type	Description
config	OdinMediaConfig	Microphone device configuration

Returns

Type	Description
Boolean	true if media was added to the room or false

`}),e.add({id:528,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/createmicrophonemedia/",title:"CreateMicrophoneMedia",section:"ODIN Documentation",description:"",content:`

public bool CreateMicrophoneMedia(OdinMediaConfig config)

Try to add a MicrophoneMedia

Parameters

Name	Type	Description
config	OdinMediaConfig	Microphone device configuration

Returns

Type	Description
Boolean	true if media was added to the room or false

`}),e.add({id:529,href:"https://www.4players.io/odin/sdk/unity/classes/room/createmicrophonemedia/",title:"CreateMicrophoneMedia",section:"ODIN Documentation",description:"",content:`

public bool CreateMicrophoneMedia(OdinMediaConfig config)

Try to add a MicrophoneMedia

Parameters

Name	Type	Description
config	OdinMediaConfig	Microphone device configuration

Returns

Type	Description
Boolean	true if media was added to the room or false

`}),e.add({id:530,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/createplayback/",title:"CreatePlayback",section:"ODIN Documentation",description:" Creates on events ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool CreatePlayback

Creates Room_OnMediaAdded(System events

Value Type

Type	Description
Boolean

`}),e.add({id:531,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/createplayback/",title:"CreatePlayback",section:"ODIN Documentation",description:" Creates on events ",content:`

public bool CreatePlayback

Creates Room_OnMediaAdded(System events

Value Type

Type	Description
Boolean

`}),e.add({id:532,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/createplayback/",title:"CreatePlayback",section:"ODIN Documentation",description:" Creates on events ",content:`

public bool CreatePlayback

Creates Room_OnMediaAdded(System events

Value Type

Type	Description
Boolean

`}),e.add({id:533,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/createplayback/",title:"CreatePlayback",section:"ODIN Documentation",description:" Creates on events ",content:`

public bool CreatePlayback

Creates Room_OnMediaAdded(System events

Value Type

Type	Description
Boolean

`}),e.add({id:534,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/createplayback/",title:"CreatePlayback",section:"ODIN Documentation",description:" Creates on events ",content:`

public bool CreatePlayback

Creates Room_OnMediaAdded(System events

Value Type

Type	Description
Boolean

`}),e.add({id:535,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/createroom/",title:"createRoom",section:"ODIN Documentation",description:"Creates a new local room instance with the given ID and user ID. Use join to connect to that room.",content:`

public createRoom(accessKey: string, roomId: string, userId: string): OdinRoom

Creates a new local room instance with the given ID and user ID. Use join to connect to that room.

Parameters

Name	Type	Description
accessKey	string	The access key to use to generate the token. You can get a free access token in our developer center
roomId	string	The ID of the room to create.
userId	string	The ID of the user to create the room for.

Returns

Type	Description
OdinRoom

`}),e.add({id:536,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/createroom/",title:"CreateRoom",section:"ODIN Documentation",description:"",content:`

public Room CreateRoom(uint samplerate, bool stereo)

Create a room for the set gateway.

Info

This is for testing and not intended for production. Access key should never be client side.

Parameters

Name	Type	Description
samplerate	UInt32	room default samplerate fallback
stereo	Boolean	room default stereo flag fallback

Returns

Type	Description
Room	Room object with a connection

`}),e.add({id:537,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/createroomwithaccesstoken/",title:"createRoomWithAccessToken",section:"ODIN Documentation",description:"Creates a new local room instance with the given access token. Use `join` on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling `generateToken`. To be more consistent with other SDKs, this method is deprecated. Use createRoomWithToken instead.",content:`

public createRoomWithAccessToken(accessToken: string): OdinRoom

Creates a new local room instance with the given access token. Use join on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling generateToken. To be more consistent with other SDKs, this method is deprecated. Use createRoomWithToken instead.

Parameters

Name	Type	Description
accessToken	string	The access token to use to join the room.

Returns

Type	Description
OdinRoom

`}),e.add({id:538,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/createroomwithtoken/",title:"createRoomWithToken",section:"ODIN Documentation",description:"Creates a new local room instance with the given room token. Use `join` on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling `generateAccessToken`.",content:`

public createRoomWithToken(accessToken: string): OdinRoom

Creates a new local room instance with the given room token. Use join on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling generateAccessToken.

Parameters

Name	Type	Description
accessToken	string	The access token to use to join the room.

Returns

Type	Description
OdinRoom

`}),e.add({id:539,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/createtoken/",title:"CreateToken",section:"ODIN Documentation",description:"",content:`

public static string CreateToken(string accesskey, string body)

Create a example token to join a room. For production use a token server!

Info

This is for testing and not intended for production. Access key should never be client side.

Parameters

Name	Type	Description
accesskey	String	Key to generate a token from
body	String	token body

Returns

Type	Description
String	token string or empty

`}),e.add({id:540,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/enumerator/current/",title:"Current",section:"ODIN Documentation",description:"",content:`

public readonly KeyValuePair<string, MsgPackReader> Current { get; }

Value Type

Type	Description
KeyValuePair<MsgPackReader>

`}),e.add({id:541,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/constructor_0/",title:"CustomEffect(OdinPipelineHandle, UInt32)",section:"ODIN Documentation",description:"",content:`

protected CustomEffect(OdinPipelineHandle parentHandle, uint effectId)

Internal effect constructor, use CustomEffect.Create{T}(MediaPipeline, Action{OdinCallbackAudioData, T}, T)"

Parameters

Name	Description
parentHandle	pipeline handle
effectId	effect id

`}),e.add({id:542,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/",title:"CustomEffect",section:"ODIN Documentation",description:" Custom effect for callbacks ",content:`

Inherits from: PiplineEffect

public class CustomEffect<T> : PiplineEffect, IPiplineEffect where T : struct

Custom effect for Odin callbacks

Constructors

Name	Description
CustomEffect(OdinPipelineHandle, UInt32)	Internal effect constructor, use `CustomEffect.Create{T}(MediaPipeline, Action{OdinCallbackAudioData, T}, T)"`

Static Methods

Name	Description
Create	Insert a custom effect in the specified pipline
Serialize	Serialize structure to pointer for arbitary data T
Deserialize	Deserializes a structure from a byte array

Public Methods

Name	Description
SerializeUserdata	Serialize arbitary userdata
DeserializeUserdata	Deserializes userdata from a byte array

Inherited Properties

Name	Description
Id	Effect id
Index	Effect index
Parent	Pipeline handle

Inherited Methods

Name	Description
GetEffectIndex	Get native effect index
GetEffectType	Get native effect NativeBindings
GetVadConfig	Get native voice activity config
SetApmConfig	Set native audio processing config
SetApmStreamDelay	Set native audio processing delay
SetVadConfig	Set native voice activity config
UpdateApmPlayback	Send samples for native audio processing

`}),e.add({id:543,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincolliderfiltercomponent/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public override void CustomEffectCallback(OdinCallbackAudioData audio, IntPtr _)

Parameters

Name	Type	Description
audio	OdinCallbackAudioData
_	IntPtr

`}),e.add({id:544,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public virtual void CustomEffectCallback(OdinCallbackAudioData audio, U _)

Callback delegate for the effect

Parameters

Name	Type	Description
audio	OdinCallbackAudioData	audio data wrapper for copy buffer to native
_	<U>

`}),e.add({id:545,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmuteaudiocomponent/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public override void CustomEffectCallback(OdinCallbackAudioData audio, IntPtr _)

Parameters

Name	Type	Description
audio	OdinCallbackAudioData
_	IntPtr

`}),e.add({id:546,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public override void CustomEffectCallback(OdinCallbackAudioData audio, OdinTerrainFilterComponent.TerrainFilterUserData userData)

Parameters

Name	Type	Description
audio	OdinCallbackAudioData
userData	TerrainFilterUserData

`}),e.add({id:547,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumeboostcomponent/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public override void CustomEffectCallback(OdinCallbackAudioData audio, IntPtr _)

Parameters

Name	Type	Description
audio	OdinCallbackAudioData
_	IntPtr

`}),e.add({id:548,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumecomponent/customeffectcallback/",title:"CustomEffectCallback",section:"ODIN Documentation",description:"",content:`

public override void CustomEffectCallback(OdinCallbackAudioData audio, IntPtr _)

Parameters

Name	Type	Description
audio	OdinCallbackAudioData
_	IntPtr

`}),e.add({id:549,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/customer/",title:"customer",section:"ODIN Documentation",description:"The customer identifier this room is assigned to.",content:`

string

The customer identifier this room is assigned to.

`}),e.add({id:550,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool CustomInputDevice

Value Type

Type	Description
Boolean

`}),e.add({id:551,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:" Enable/Disable the use of as a new/fixed device name ",content:`

public bool CustomInputDevice

Enable/Disable the use of InputDevice as a new/fixed device name

Value Type

Type	Description
Boolean

`}),e.add({id:552,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:" Enable/Disable the use of as a new/fixed device name ",content:`

public bool CustomInputDevice

Enable/Disable the use of InputDevice as a new/fixed device name

Value Type

Type	Description
Boolean

`}),e.add({id:553,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:" Enable/Disable the use of as a new/fixed device name ",content:`

public bool CustomInputDevice

Enable/Disable the use of MicrophoneReader as a new/fixed device name

Value Type

Type	Description
Boolean

`}),e.add({id:554,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:" Enable/Disable the use of as a new/fixed device name ",content:`

public bool CustomInputDevice

Enable/Disable the use of InputDevice as a new/fixed device name

Value Type

Type	Description
Boolean

`}),e.add({id:555,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/custominputdevice/",title:"CustomInputDevice",section:"ODIN Documentation",description:" Enable/Disable the use of as a new/fixed device name ",content:`

public bool CustomInputDevice

Enable/Disable the use of InputDevice as a new/fixed device name

Value Type

Type	Description
Boolean

`}),e.add({id:556,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/custominputvolumescale/",title:"CustomInputVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomInputVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:557,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:558,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:559,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:560,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:561,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:562,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/custommicvolumescale/",title:"CustomMicVolumeScale",section:"ODIN Documentation",description:"",content:`

public bool CustomMicVolumeScale

Value Type

Type	Description
Boolean

`}),e.add({id:563,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/cwnd/",title:"cwnd",section:"ODIN Documentation",description:" Current congestion window of the connection ",content:`

public ulong cwnd

Current congestion window of the connection

Value Type

Type	Description
UInt64

`}),e.add({id:564,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/cwnd/",title:"cwnd",section:"ODIN Documentation",description:" Current congestion window of the connection ",content:`

public ulong cwnd

Current congestion window of the connection

Value Type

Type	Description
UInt64

`}),e.add({id:565,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/cwnd/",title:"cwnd",section:"ODIN Documentation",description:" Current congestion window of the connection ",content:`

public ulong cwnd

Current congestion window of the connection

Value Type

Type	Description
UInt64

`}),e.add({id:566,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/data/",title:"data",section:"ODIN Documentation",description:"The arbitrary user data of the peer.",content:`

Uint8Array

The arbitrary user data of the peer.

`}),e.add({id:567,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/data/",title:"data",section:"ODIN Documentation",description:"The arbitrary user data of the room.",content:`

Uint8Array

The arbitrary user data of the room.

`}),e.add({id:568,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:569,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:570,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:571,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:572,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:573,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:574,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:575,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:576,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:577,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/data/",title:"Data",section:"ODIN Documentation",description:"",content:`

public Terrain Data

Value Type

Type	Description
Terrain

`}),e.add({id:578,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:579,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/messagepackextension/data/",title:"Data",section:"ODIN Documentation",description:"",content:`

public byte[] Data

Value Type

Type	Description
Byte[]

`}),e.add({id:580,href:"https://www.4players.io/odin/sdk/unity/classes/messagereceivedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" arbitrary data ",content:`

public byte[] Data

arbitrary data

Value Type

Type	Description
Byte[]

`}),e.add({id:581,href:"https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedeventargs/data/",title:"Data",section:"ODIN Documentation",description:" room userdata ",content:`

public UserData Data

room userdata

Value Type

Type	Description
UserData

`}),e.add({id:582,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagrameventargs/datagram/",title:"Datagram",section:"ODIN Documentation",description:" decoder datagram ",content:`

public NativeBindings.OdinDatagramRecv Datagram { get; }

decoder datagram

Value Type

Type	Description
OdinDatagramRecv

`}),e.add({id:583,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagrameventargs/",title:"DatagramEventArgs",section:"ODIN Documentation",description:" Arguments for datagram events ",content:`

public class DatagramEventArgs : EventArgs

Arguments for datagram events

Properties

Name	Description
RoomId	room id
Datagram	decoder datagram
Payload	decoder datagram payload
Userdata	unused

`}),e.add({id:584,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/datagrameventhandler/",title:"DatagramEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void DatagramEventHandler(object sender, DatagramEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	DatagramEventArgs	Arguments events

`}),e.add({id:585,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagramproxy/",title:"DatagramProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class DatagramProxy : UnityEvent<object, DatagramEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:586,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:587,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:588,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:589,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:590,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:591,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/debug/",title:"Debug",section:"ODIN Documentation",description:" Enable additional debug logs ",content:`

public static bool Debug

Enable additional debug logs

Value Type

Type	Description
Boolean

`}),e.add({id:592,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiostats/decoder/",title:"decoder",section:"ODIN Documentation",description:"Internal Opus decoder statistics.",content:`

{avg_decode_time: number, cache_length: number, packets_invalid: number, packets_lost: number, packets_processed: number, packets_repeated: number, packets_seen: number, packets_too_early: number, packets_too_late: number, rewinds: number}

Internal Opus decoder statistics.

`}),e.add({id:593,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/decoders/",title:"Decoders",section:"ODIN Documentation",description:" Elements of room output medias ",content:`

public IEnumerable<MediaDecoder> Decoders { get; }

Elements of room output medias

Value Type

Type	Description
IEnumerable<MediaDecoder>

`}),e.add({id:594,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:595,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:596,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:597,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:598,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:599,href:"https://www.4players.io/odin/sdk/unity/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Delegates:

`}),e.add({id:600,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/deserialize/",title:"Deserialize",section:"ODIN Documentation",description:"",content:`

public static T Deserialize(byte[] data)
public static T Deserialize(IntPtr ptr)

Deserializes a structure from a byte array

Info

copy to Marshal.PtrToStructure

Parameters

Name	Type	Description
data	Byte[]	binary data to deserialize
ptr	IntPtr	pointer to deserialize as structure

Returns

Type	Description
<T>	structure

Variants

Deserialize(data)

public static T Deserialize(byte[] data)

Deserializes a structure from a byte array

Warning

copy to Marshal.PtrToStructure

Parameters

Name	Type	Description
data	Byte[]	binary data to deserialize

Returns

Type	Description
<T>	structure

Deserialize(ptr)

public static T Deserialize(IntPtr ptr)

Deserializes a structure from a pointer

Parameters

Name	Type	Description
ptr	IntPtr	pointer to deserialize as structure

Returns

Type	Description
<T>	structure

`}),e.add({id:601,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/deserializeuserdata/",title:"DeserializeUserdata",section:"ODIN Documentation",description:"",content:`

public virtual T DeserializeUserdata(byte[] data)
public virtual T DeserializeUserdata(IntPtr ptr)

Deserializes userdata from a byte array

Parameters

Name	Type	Description
data	Byte[]	custom userdata
ptr	IntPtr	pointer

Returns

Type	Description
<T>	Instance of

Variants

DeserializeUserdata(data)

public virtual T DeserializeUserdata(byte[] data)

Deserializes userdata from a byte array

Parameters

Name	Type	Description
data	Byte[]	custom userdata

Returns

Type	Description
<T>	Instance of

DeserializeUserdata(ptr)

public virtual T DeserializeUserdata(IntPtr ptr)

Deserializes userdata from a pointer

Parameters

Name	Type	Description
ptr	IntPtr	pointer

Returns

Type	Description
<T>	Instance of

`}),e.add({id:602,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/destroyonerror/",title:"DestroyOnError",section:"ODIN Documentation",description:"",content:`

public bool DestroyOnError

Value Type

Type	Description
Boolean

`}),e.add({id:603,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/destroyplaybackcomponents/",title:"DestroyPlaybackComponents",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void DestroyPlaybackComponents()
public void DestroyPlaybackComponents(string roomId)
public void DestroyPlaybackComponents(ulong peerId)
public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio instances

Info

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Variants

DestroyPlaybackComponents()

public void DestroyPlaybackComponents()

Destroys all Audio instances

Warning

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

DestroyPlaybackComponents(roomId)

public void DestroyPlaybackComponents(string roomId)

Destroys all Audio filtered by room

Warning

This will free all medias with a PlaybackComponent by room and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

DestroyPlaybackComponents(peerId)

public void DestroyPlaybackComponents(ulong peerId)

Destroys all Audio filtered by peer

Warning

This will free all medias with a PlaybackComponent from a peer and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
peerId	UInt64	peer ID

DestroyPlaybackComponents(mediaStreamId)

public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio filtered by media

Warning

This will free the media with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

`}),e.add({id:604,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/destroyplaybackcomponents/",title:"DestroyPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public void DestroyPlaybackComponents()
public void DestroyPlaybackComponents(string roomId)
public void DestroyPlaybackComponents(ulong peerId)
public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio instances

Info

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Variants

DestroyPlaybackComponents()

public void DestroyPlaybackComponents()

Destroys all Audio instances

Warning

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

DestroyPlaybackComponents(roomId)

public void DestroyPlaybackComponents(string roomId)

Destroys all Audio filtered by room

Warning

This will free all medias with a PlaybackComponent by room and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

DestroyPlaybackComponents(peerId)

public void DestroyPlaybackComponents(ulong peerId)

Destroys all Audio filtered by peer

Warning

This will free all medias with a PlaybackComponent from a peer and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
peerId	UInt64	peer ID

DestroyPlaybackComponents(mediaStreamId)

public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio filtered by media

Warning

This will free the media with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

`}),e.add({id:605,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/destroyplaybackcomponents/",title:"DestroyPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public void DestroyPlaybackComponents()
public void DestroyPlaybackComponents(string roomId)
public void DestroyPlaybackComponents(ulong peerId)
public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio instances

Info

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Variants

DestroyPlaybackComponents()

public void DestroyPlaybackComponents()

Destroys all Audio instances

Warning

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

DestroyPlaybackComponents(roomId)

public void DestroyPlaybackComponents(string roomId)

Destroys all Audio filtered by room

Warning

This will free all medias with a PlaybackComponent by room and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

DestroyPlaybackComponents(peerId)

public void DestroyPlaybackComponents(ulong peerId)

Destroys all Audio filtered by peer

Warning

This will free all medias with a PlaybackComponent from a peer and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
peerId	UInt64	peer ID

DestroyPlaybackComponents(mediaStreamId)

public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio filtered by media

Warning

This will free the media with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

`}),e.add({id:606,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/destroyplaybackcomponents/",title:"DestroyPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public void DestroyPlaybackComponents()
public void DestroyPlaybackComponents(string roomId)
public void DestroyPlaybackComponents(ulong peerId)
public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio instances

Info

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Variants

DestroyPlaybackComponents()

public void DestroyPlaybackComponents()

Destroys all Audio instances

Warning

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

DestroyPlaybackComponents(roomId)

public void DestroyPlaybackComponents(string roomId)

Destroys all Audio filtered by room

Warning

This will free all medias with a PlaybackComponent by room and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

DestroyPlaybackComponents(peerId)

public void DestroyPlaybackComponents(ulong peerId)

Destroys all Audio filtered by peer

Warning

This will free all medias with a PlaybackComponent from a peer and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
peerId	UInt64	peer ID

DestroyPlaybackComponents(mediaStreamId)

public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio filtered by media

Warning

This will free the media with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

`}),e.add({id:607,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/destroyplaybackcomponents/",title:"DestroyPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public void DestroyPlaybackComponents()
public void DestroyPlaybackComponents(string roomId)
public void DestroyPlaybackComponents(ulong peerId)
public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio instances

Info

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Variants

DestroyPlaybackComponents()

public void DestroyPlaybackComponents()

Destroys all Audio instances

Warning

This will free all medias with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

DestroyPlaybackComponents(roomId)

public void DestroyPlaybackComponents(string roomId)

Destroys all Audio filtered by room

Warning

This will free all medias with a PlaybackComponent by room and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

DestroyPlaybackComponents(peerId)

public void DestroyPlaybackComponents(ulong peerId)

Destroys all Audio filtered by peer

Warning

This will free all medias with a PlaybackComponent from a peer and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
peerId	UInt64	peer ID

DestroyPlaybackComponents(mediaStreamId)

public void DestroyPlaybackComponents(long mediaStreamId)

Destroys all Audio filtered by media

Warning

This will free the media with a PlaybackComponent and removes the associated AudioSource, If Audio is set!

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

`}),e.add({id:608,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/device_max/",title:"Device_Max",section:"ODIN Documentation",description:" Hardware device max samplerate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Device_Max = 1U

Hardware device max samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:609,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/device_max/",title:"Device_Max",section:"ODIN Documentation",description:" Hardware device max samplerate ",content:`

Device_Max = 1U

Hardware device max samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:610,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/device_max/",title:"Device_Max",section:"ODIN Documentation",description:" Hardware device max samplerate ",content:`

Device_Max = 1U

Hardware device max samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:611,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/device_max/",title:"Device_Max",section:"ODIN Documentation",description:" Hardware device max samplerate ",content:`

Device_Max = 1U

Hardware device max samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:612,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/device_max/",title:"Device_Max",section:"ODIN Documentation",description:" Hardware device max samplerate ",content:`

Device_Max = 1U

Hardware device max samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:613,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/device_min/",title:"Device_Min",section:"ODIN Documentation",description:" Hardware device min samplerate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Device_Min = 0U

Hardware device min samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:614,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/device_min/",title:"Device_Min",section:"ODIN Documentation",description:" Hardware device min samplerate ",content:`

Device_Min = 0U

Hardware device min samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:615,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/device_min/",title:"Device_Min",section:"ODIN Documentation",description:" Hardware device min samplerate ",content:`

Device_Min = 0U

Hardware device min samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:616,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/device_min/",title:"Device_Min",section:"ODIN Documentation",description:" Hardware device min samplerate ",content:`

Device_Min = 0U

Hardware device min samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:617,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/device_min/",title:"Device_Min",section:"ODIN Documentation",description:" Hardware device min samplerate ",content:`

Device_Min = 0U

Hardware device min samplerate

Info

Should currently not be used!

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:618,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone default Channel ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static MediaChannels DeviceChannels { get; set; }

Microphone default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:619,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone Channels ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaChannels DeviceChannels

Microphone Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:620,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone default Channel ",content:`

public static MediaChannels DeviceChannels { get; set; }

Microphone default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:621,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone Channels ",content:`

public MediaChannels DeviceChannels

Microphone Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:622,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone default Channel ",content:`

public static MediaChannels DeviceChannels { get; set; }

Microphone default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:623,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone Channels ",content:`

public MediaChannels DeviceChannels

Microphone Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:624,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone default Channel ",content:`

public static MediaChannels DeviceChannels { get; set; }

Microphone default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:625,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone Channels ",content:`

public MediaChannels DeviceChannels

Microphone Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:626,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone default Channel ",content:`

public static MediaChannels DeviceChannels { get; set; }

Microphone default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:627,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/devicechannels/",title:"DeviceChannels",section:"ODIN Documentation",description:" Microphone Channels ",content:`

public MediaChannels DeviceChannels

Microphone Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:628,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone default Sample-Rate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static MediaSampleRate DeviceSampleRate { get; set; }

Microphone default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:629,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone Sample-Rate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaSampleRate DeviceSampleRate

Microphone Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:630,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone default Sample-Rate ",content:`

public static MediaSampleRate DeviceSampleRate { get; set; }

Microphone default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:631,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone Sample-Rate ",content:`

public MediaSampleRate DeviceSampleRate

Microphone Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:632,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone default Sample-Rate ",content:`

public static MediaSampleRate DeviceSampleRate { get; set; }

Microphone default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:633,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone Sample-Rate ",content:`

public MediaSampleRate DeviceSampleRate

Microphone Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:634,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone default Sample-Rate ",content:`

public static MediaSampleRate DeviceSampleRate { get; set; }

Microphone default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:635,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone Sample-Rate ",content:`

public MediaSampleRate DeviceSampleRate

Microphone Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:636,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone default Sample-Rate ",content:`

public static MediaSampleRate DeviceSampleRate { get; set; }

Microphone default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:637,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/devicesamplerate/",title:"DeviceSampleRate",section:"ODIN Documentation",description:" Microphone Sample-Rate ",content:`

public MediaSampleRate DeviceSampleRate

Microphone Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:638,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/disablevad/",title:"disableVAD",section:"ODIN Documentation",description:"Disables RNN-based voice activity detection.",content:`

disableVAD(): void

Disables RNN-based voice activity detection.

Returns

Type	Description
void

`}),e.add({id:639,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/disablevolumegate/",title:"disableVolumeGate",section:"ODIN Documentation",description:"Disables RNN-based voice activity detection.",content:`

disableVolumeGate(): void

Disables RNN-based voice activity detection.

Returns

Type	Description
void

`}),e.add({id:640,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/disconnect/",title:"disconnect",section:"ODIN Documentation",description:"Disconnects from all rooms and stops all audio handling.",content:`

disconnect(state: OdinConnectionState): void

Disconnects from all rooms and stops all audio handling.

Parameters

Name	Type	Description
state	OdinConnectionState

Returns

Type	Description
void

`}),e.add({id:641,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstate/disconnected/",title:"Disconnected",section:"ODIN Documentation",description:" Connection is closed ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Disconnected = 2

Connection is closed

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:642,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstate/disconnected/",title:"Disconnected",section:"ODIN Documentation",description:" Connection is closed ",content:`

Disconnected = 2

Connection is closed

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:643,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstate/disconnected/",title:"Disconnected",section:"ODIN Documentation",description:" Connection is closed ",content:`

Disconnected = 2

Connection is closed

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:644,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstate/disconnected/",title:"Disconnected",section:"ODIN Documentation",description:" Connection is closed ",content:`

Disconnected = 2

Connection is closed

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:645,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstate/disconnected/",title:"Disconnected",section:"ODIN Documentation",description:" Connection is closed ",content:`

Disconnected = 2

Connection is closed

Value Type

Type	Description
OdinRoomConnectionState

`}),e.add({id:646,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Dispose()

On dispose will free the stream and resampler

`}),e.add({id:647,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:648,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Dispose()

Free peer with all associated medias

`}),e.add({id:649,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Dispose()

On dispose will free the room and token generator

`}),e.add({id:650,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the stream and resampler

`}),e.add({id:651,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:652,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free peer with all associated medias

`}),e.add({id:653,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the room and token generator

`}),e.add({id:654,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the stream and resampler

`}),e.add({id:655,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:656,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free peer with all associated medias

`}),e.add({id:657,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the room and token generator

`}),e.add({id:658,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the stream and resampler

`}),e.add({id:659,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:660,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free peer with all associated medias

`}),e.add({id:661,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the room and token generator

`}),e.add({id:662,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free native media decoder

`}),e.add({id:663,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free native media encoder

`}),e.add({id:664,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

dispose

`}),e.add({id:665,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:666,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

`}),e.add({id:667,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free peer with all associated medias

`}),e.add({id:668,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the room and all associated data

`}),e.add({id:669,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/enumerator/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

`}),e.add({id:670,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the stream and resampler

`}),e.add({id:671,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free all NativeMethods

Info

Override dispose if muliple Odin are needed

`}),e.add({id:672,href:"https://www.4players.io/odin/sdk/unity/classes/peer/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

Free peer with all associated medias

`}),e.add({id:673,href:"https://www.4players.io/odin/sdk/unity/classes/room/dispose/",title:"Dispose",section:"ODIN Documentation",description:"",content:`

public void Dispose()

On dispose will free the room and token generator

`}),e.add({id:674,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/echo_canceller/",title:"echo_canceller",section:"ODIN Documentation",description:"",content:`

public bool echo_canceller

Value Type

Type	Description
Boolean

`}),e.add({id:675,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/echocanceller/",title:"echoCanceller",section:"ODIN Documentation",description:"Enable or disable echo cancellation",content:`

public echoCanceller: boolean

Enable or disable echo cancellation

`}),e.add({id:676,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:677,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Turns Echo cancellation on and off ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool EchoCanceller

Turns Echo cancellation on and off

Value Type

Type	Description
Boolean

`}),e.add({id:678,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Enable or disable echo cancellation ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool EchoCanceller { get; set; }

Enable or disable echo cancellation

Value Type

Type	Description
Boolean

`}),e.add({id:679,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:680,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Turns Echo cancellation on and off ",content:`

public bool EchoCanceller

Turns Echo cancellation on and off

Value Type

Type	Description
Boolean

`}),e.add({id:681,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Enable or disable echo cancellation ",content:`

public bool EchoCanceller { get; set; }

Enable or disable echo cancellation

Value Type

Type	Description
Boolean

`}),e.add({id:682,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:683,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Turns Echo cancellation on and off ",content:`

public bool EchoCanceller

Turns Echo cancellation on and off

Value Type

Type	Description
Boolean

`}),e.add({id:684,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Enable or disable echo cancellation ",content:`

public bool EchoCanceller { get; set; }

Enable or disable echo cancellation

Value Type

Type	Description
Boolean

`}),e.add({id:685,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:686,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Turns Echo cancellation on and off ",content:`

public bool EchoCanceller

Turns Echo cancellation on and off

Value Type

Type	Description
Boolean

`}),e.add({id:687,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Enable or disable echo cancellation ",content:`

public bool EchoCanceller { get; set; }

Enable or disable echo cancellation

Value Type

Type	Description
Boolean

`}),e.add({id:688,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled ",content:`

public bool EchoCanceller { get; set; }

Idicates whether the ApmConfig setting is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:689,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:"",content:`

public bool EchoCanceller

Value Type

Type	Description
Boolean

`}),e.add({id:690,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:691,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool EchoCanceller

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:692,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Turns Echo cancellation on and off ",content:`

public bool EchoCanceller

Turns Echo cancellation on and off

Value Type

Type	Description
Boolean

`}),e.add({id:693,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/echocanceller/",title:"EchoCanceller",section:"ODIN Documentation",description:" Enable or disable echo cancellation ",content:`

public bool EchoCanceller { get; set; }

Enable or disable echo cancellation

Value Type

Type	Description
Boolean

`}),e.add({id:694,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/effect/",title:"Effect",section:"ODIN Documentation",description:"",content:`

public ApmEffect Effect { get; }

Value Type

Type	Description
ApmEffect

`}),e.add({id:695,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/effect/",title:"Effect",section:"ODIN Documentation",description:" Get base effect ",content:`

public PiplineEffect Effect { get; }

Get base effect

Value Type

Type	Description
PiplineEffect

`}),e.add({id:696,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/effect/",title:"Effect",section:"ODIN Documentation",description:"",content:`

public VadEffect Effect { get; }

Value Type

Type	Description
VadEffect

`}),e.add({id:697,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/emitter/",title:"Emitter",section:"ODIN Documentation",description:"",content:`

public GameObject Emitter

Value Type

Type	Description
GameObject

`}),e.add({id:698,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinsensitivityconfig/enabled/",title:"enabled",section:"ODIN Documentation",description:"",content:`

public bool enabled

Value Type

Type	Description
Boolean

`}),e.add({id:699,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/enablevad/",title:"enableVAD",section:"ODIN Documentation",description:"Enables RNN-based voice activity detection.",content:`

enableVAD(): void

Enables RNN-based voice activity detection.

Returns

Type	Description
void

`}),e.add({id:700,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/enablevolumegate/",title:"enableVolumeGate",section:"ODIN Documentation",description:"Enables RNN-based voice activity detection.",content:`

enableVolumeGate(): void

Enables RNN-based voice activity detection.

Returns

Type	Description
void

`}),e.add({id:701,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiostats/encoder/",title:"encoder",section:"ODIN Documentation",description:"Internal Opus encoder statistics.",content:`

{avg_encode_time: number, complexity: number, complexity_factor: number, fec: boolean, fec_packet_loss: number, voip: boolean}

Internal Opus encoder statistics.

`}),e.add({id:702,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/encoders/",title:"Encoders",section:"ODIN Documentation",description:" Container of room input medias ",content:`

public ConcurrentDictionary<ushort, MediaEncoder> Encoders { get; }

Container of room input medias

Value Type

Type	Description
ConcurrentDictionary<UInt16,MediaEncoder>

`}),e.add({id:703,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:704,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:705,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:706,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:707,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Used Encoding defaults to UTF8 ",content:`

public Encoding Encoding { get; }

Used Encoding defaults to UTF8

Value Type

Type	Description
Encoding

`}),e.add({id:708,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:709,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/encoding/",title:"Encoding",section:"ODIN Documentation",description:" Default Encoding ",content:`

public Encoding Encoding { get; set; }

Default Encoding

Value Type

Type	Description
Encoding

`}),e.add({id:710,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:711,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:712,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:713,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:714,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:715,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Room server gateway endpoint ",content:`

public string EndPoint { get; }

Room server gateway endpoint

Value Type

Type	Description
String

`}),e.add({id:716,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/endpoint/",title:"EndPoint",section:"ODIN Documentation",description:" Connection EndPoint. Default from OdinEditorConfig. ",content:`

public Uri EndPoint { get; }

Connection EndPoint. Default from OdinEditorConfig.

Value Type

Type	Description
Uri

`}),e.add({id:717,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/enumerator/",title:"Enumerator",section:"ODIN Documentation",description:"",content:`

public struct Enumerator : IEnumerator<KeyValuePair<string, MsgPackReader>>

Properties

Name	Description
Current

Public Methods

Name	Description
MoveNext
Dispose

`}),e.add({id:718,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

The ODIN Unity SDK has defined these Enums:

`}),e.add({id:719,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Enums:

`}),e.add({id:720,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Enums:

`}),e.add({id:721,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Enums:

`}),e.add({id:722,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Enums:

OdinError

`}),e.add({id:723,href:"https://www.4players.io/odin/sdk/unity/enums/",title:"Enums",section:"ODIN Documentation",description:"An index of all Enums available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Enums:

OdinAudioDataReceivedEventPayload

`}),e.add({id:724,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Equals(MediaStream x, MediaStream y)

Determines whether the streams are equal

Parameters

Name	Type	Description
x	MediaStream	stream
y	MediaStream	stream

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:725,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Equals(Peer x, Peer y)

Determines whether the peers are equal

Parameters

Name	Type	Description
x	Peer	peer
y	Peer	peer

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:726,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:727,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(MediaStream x, MediaStream y)

Determines whether the streams are equal

Parameters

Name	Type	Description
x	MediaStream	stream
y	MediaStream	stream

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:728,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Peer x, Peer y)

Determines whether the peers are equal

Parameters

Name	Type	Description
x	Peer	peer
y	Peer	peer

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:729,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:730,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(MediaStream x, MediaStream y)

Determines whether the streams are equal

Parameters

Name	Type	Description
x	MediaStream	stream
y	MediaStream	stream

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:731,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Peer x, Peer y)

Determines whether the peers are equal

Parameters

Name	Type	Description
x	Peer	peer
y	Peer	peer

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:732,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:733,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(MediaStream x, MediaStream y)

Determines whether the streams are equal

Parameters

Name	Type	Description
x	MediaStream	stream
y	MediaStream	stream

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:734,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Peer x, Peer y)

Determines whether the peers are equal

Parameters

Name	Type	Description
x	Peer	peer
y	Peer	peer

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:735,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:736,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:737,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(MediaStream x, MediaStream y)

Determines whether the streams are equal

Parameters

Name	Type	Description
x	MediaStream	stream
y	MediaStream	stream

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:738,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Peer x, Peer y)

Determines whether the peers are equal

Parameters

Name	Type	Description
x	Peer	peer
y	Peer	peer

Returns

Type	Description
Boolean	true if equal or false

`}),e.add({id:739,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/equals/",title:"Equals",section:"ODIN Documentation",description:"",content:`

public bool Equals(Room x, Room y)

Compares two rooms by name

Parameters

Name	Type	Description
x	Room	room
y	Room	room

Returns

Type	Description
Boolean	is equal

`}),e.add({id:740,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcresult/error/",title:"Error",section:"ODIN Documentation",description:" error ",content:`

public string Error { get; }

error

Value Type

Type	Description
String

`}),e.add({id:741,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public uint ErrorCode

OdinErrorCode

Value Type

Type	Description
UInt32

`}),e.add({id:742,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

public uint ErrorCode

OdinErrorCode

Value Type

Type	Description
UInt32

`}),e.add({id:743,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

public uint ErrorCode

OdinErrorCode

Value Type

Type	Description
UInt32

`}),e.add({id:744,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

public uint ErrorCode

OdinErrorCode

Value Type

Type	Description
UInt32

`}),e.add({id:745,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

public OdinError ErrorCode

OdinErrorCode

Value Type

Type	Description
OdinError

`}),e.add({id:746,href:"https://www.4players.io/odin/sdk/unity/classes/odinexception/errorcode/",title:"ErrorCode",section:"ODIN Documentation",description:" OdinErrorCode ",content:`

public uint ErrorCode

OdinErrorCode

Value Type

Type	Description
UInt32

`}),e.add({id:747,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/response/errorindex/",title:"ErrorIndex",section:"ODIN Documentation",description:" binary|string|null field (error) ",content:`

public const int ErrorIndex = 2

binary|string|null field (error)

Value Type

Type	Description
Int32

`}),e.add({id:748,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinconnectionstatechangedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:749,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odineventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:750,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:751,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinlefteventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:752,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaactivityeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:753,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaaddedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:754,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaremovedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:755,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmessagereceivedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:756,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:757,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerlefteventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:758,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeeruserdatachangedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:759,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinroomuserdatachangedeventpayload/event/",title:"event",section:"ODIN Documentation",description:"The name of the event that was fired (see keys of OdinEvents for possible values).",content:`

public event: any

The name of the event that was fired (see keys of OdinEvents for possible values).

`}),e.add({id:760,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/eventuserdata/",title:"EventUserdata",section:"ODIN Documentation",description:" Custom connection userdata ",content:`

public MarshalByRefObject EventUserdata { get; }

Custom connection userdata

Value Type

Type	Description
MarshalByRefObject

`}),e.add({id:761,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumeboostcomponent/exponentofscale/",title:"ExponentOfScale",section:"ODIN Documentation",description:"",content:`

public float ExponentOfScale

Value Type

Type	Description
Single

`}),e.add({id:762,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/ext16/",title:"Ext16",section:"ODIN Documentation",description:"",content:`

public const byte Ext16 = 200

Value Type

Type	Description
Byte

`}),e.add({id:763,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/ext32/",title:"Ext32",section:"ODIN Documentation",description:"",content:`

public const byte Ext32 = 201

Value Type

Type	Description
Byte

`}),e.add({id:764,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/ext8/",title:"Ext8",section:"ODIN Documentation",description:"",content:`

public const byte Ext8 = 199

Value Type

Type	Description
Byte

`}),e.add({id:765,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/exttypecode_timestamp/",title:"ExtTypeCode_Timestamp",section:"ODIN Documentation",description:"",content:`

public const sbyte ExtTypeCode_Timestamp = -1

Value Type

Type	Description
SByte

`}),e.add({id:766,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/false/",title:"False",section:"ODIN Documentation",description:"",content:`

public const byte False = 194

Value Type

Type	Description
Byte

`}),e.add({id:767,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/fixext1/",title:"FixExt1",section:"ODIN Documentation",description:"",content:`

public const byte FixExt1 = 212

Value Type

Type	Description
Byte

`}),e.add({id:768,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/fixext16/",title:"FixExt16",section:"ODIN Documentation",description:"",content:`

public const byte FixExt16 = 216

Value Type

Type	Description
Byte

`}),e.add({id:769,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/fixext2/",title:"FixExt2",section:"ODIN Documentation",description:"",content:`

public const byte FixExt2 = 213

Value Type

Type	Description
Byte

`}),e.add({id:770,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/fixext4/",title:"FixExt4",section:"ODIN Documentation",description:"",content:`

public const byte FixExt4 = 214

Value Type

Type	Description
Byte

`}),e.add({id:771,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/fixext8/",title:"FixExt8",section:"ODIN Documentation",description:"",content:`

public const byte FixExt8 = 215

Value Type

Type	Description
Byte

`}),e.add({id:772,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/float32/",title:"Float32",section:"ODIN Documentation",description:"",content:`

public const byte Float32 = 202

Value Type

Type	Description
Byte

`}),e.add({id:773,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/float64/",title:"Float64",section:"ODIN Documentation",description:"",content:`

public const byte Float64 = 203

Value Type

Type	Description
Byte

`}),e.add({id:774,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/flush/",title:"Flush",section:"ODIN Documentation",description:"",content:`

public void Flush()

`}),e.add({id:775,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/flushframebuffer/",title:"FlushFrameBuffer",section:"ODIN Documentation",description:"",content:`

public void FlushFrameBuffer()

`}),e.add({id:776,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/flushownpeerdataupdate/",title:"flushOwnPeerDataUpdate",section:"ODIN Documentation",description:"Sends updated user data of your own peer to the server.",content:`

flushOwnPeerDataUpdate(): Promise<void>

Sends updated user data of your own peer to the server.

Returns

Type	Description
Promise<void>

`}),e.add({id:777,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/flushsilentflag/",title:"FlushSilentFlag",section:"ODIN Documentation",description:"",content:`

public void FlushSilentFlag()

`}),e.add({id:778,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/freeroom/",title:"FreeRoom",section:"ODIN Documentation",description:"",content:`

public bool FreeRoom(ulong roomId)
public bool FreeRoom(Room room)

Close and remove a room by Id

Parameters

Name	Type	Description
roomId	UInt64	room id
room	Room

Returns

Type	Description
Boolean	true on success or false

Variants

FreeRoom(roomId)

public bool FreeRoom(ulong roomId)

Close and remove a room by Id

Parameters

Name	Type	Description
roomId	UInt64	room id

Returns

Type	Description
Boolean	true on success or false

FreeRoom(room)

public bool FreeRoom(Room room)

Close and remove a room

Parameters

Name	Type	Description
room	Room

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:779,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/freerooms/",title:"FreeRooms",section:"ODIN Documentation",description:"",content:`

public void FreeRooms()

Free all Room associated.

Info

Should only be called in Loading-Screens or Scene transissions

`}),e.add({id:780,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/gain_controller/",title:"gain_controller",section:"ODIN Documentation",description:"",content:`

public bool gain_controller

Value Type

Type	Description
Boolean

`}),e.add({id:781,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/gaincontroller/",title:"gainController",section:"ODIN Documentation",description:"Enable or disable the gain controller",content:`

public gainController: boolean

Enable or disable the gain controller

`}),e.add({id:782,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool GainController

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:783,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Turns gain controller on and off ",content:`

public bool GainController

Turns gain controller on and off

Value Type

Type	Description
Boolean

`}),e.add({id:784,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Enable or disable the gain controller ",content:`

public bool GainController { get; set; }

Enable or disable the gain controller

Value Type

Type	Description
Boolean

`}),e.add({id:785,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Turns gain controller on and off ",content:`

public bool GainController

Turns gain controller on and off

Value Type

Type	Description
Boolean

`}),e.add({id:786,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool GainController

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:787,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Turns gain controller on and off ",content:`

public bool GainController

Turns gain controller on and off

Value Type

Type	Description
Boolean

`}),e.add({id:788,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Enable or disable the gain controller ",content:`

public bool GainController { get; set; }

Enable or disable the gain controller

Value Type

Type	Description
Boolean

`}),e.add({id:789,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled ",content:`

public bool GainController { get; set; }

Idicates whether the ApmConfig setting is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:790,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:"",content:`

public bool GainController

Value Type

Type	Description
Boolean

`}),e.add({id:791,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool GainController

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:792,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool GainController

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:793,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Turns gain controller on and off ",content:`

public bool GainController

Turns gain controller on and off

Value Type

Type	Description
Boolean

`}),e.add({id:794,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/gaincontroller/",title:"GainController",section:"ODIN Documentation",description:" Enable or disable the gain controller ",content:`

public bool GainController { get; set; }

Enable or disable the gain controller

Value Type

Type	Description
Boolean

`}),e.add({id:795,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/gateway/",title:"Gateway",section:"ODIN Documentation",description:" Odin endpoint server ",content:`

public string Gateway

Odin endpoint server

Value Type

Type	Description
String

`}),e.add({id:796,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinclientsettings/gatewayurl/",title:"gatewayUrl",section:"ODIN Documentation",description:"The URL of the ODIN gateway to use.",content:`

string

The URL of the ODIN gateway to use.

`}),e.add({id:797,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/generateaccesstoken/",title:"generateAccessToken",section:"ODIN Documentation",description:"Generates a token for the given access key, room and user ID. This token can be used to join the room. To be more consistent with other SDKs, this method is deprecated. Use generateToken instead.",content:`

public generateAccessToken(accessKey: string, roomId: string, userId: string): string

Generates a token for the given access key, room and user ID. This token can be used to join the room. To be more consistent with other SDKs, this method is deprecated. Use generateToken instead.

Parameters

Name	Type	Description
accessKey	string	The access key to use to generate the token. You can get a free access token in our developer center
roomId	string	The ID of the room to generate the token for.
userId	string	The ID of the user to generate the token for.

Returns

Type	Description
string

`}),e.add({id:798,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/generatetoken/",title:"generateToken",section:"ODIN Documentation",description:"Generates a room token for the given access key, room and user ID. This token can be used to join the room.",content:`

public generateToken(accessKey: string, roomId: string, userId: string): string

Generates a room token for the given access key, room and user ID. This token can be used to join the room.

Parameters

Name	Type	Description
accessKey	string	The access key to use to generate the token. You can get a free access token in our developer center
roomId	string	The ID of the room to generate the token for.
userId	string	The ID of the user to generate the token for.

Returns

Type	Description
string

`}),e.add({id:799,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/generatetoken/",title:"GenerateToken",section:"ODIN Documentation",description:"",content:`

public bool GenerateToken(string body, out string token)

Create a example token to join a room. For production use a token server!

Info

This is for testing and not intended for production. Access key should never be client side.

Parameters

Name	Type	Description
body	String	token body
token	String	token string

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:800,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/generateuiaccesskey/",title:"GenerateUIAccessKey",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void GenerateUIAccessKey()

`}),e.add({id:801,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/generateuiaccesskey/",title:"GenerateUIAccessKey",section:"ODIN Documentation",description:"",content:`

public void GenerateUIAccessKey()

`}),e.add({id:802,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/generateuiaccesskey/",title:"GenerateUIAccessKey",section:"ODIN Documentation",description:"",content:`

public void GenerateUIAccessKey()

`}),e.add({id:803,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/generateuiaccesskey/",title:"GenerateUIAccessKey",section:"ODIN Documentation",description:"",content:`

public void GenerateUIAccessKey()

`}),e.add({id:804,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/generateuiaccesskey/",title:"GenerateUIAccessKey",section:"ODIN Documentation",description:"",content:`

public void GenerateUIAccessKey()

`}),e.add({id:805,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/getaudiosettings/",title:"getAudioSettings",section:"ODIN Documentation",description:"Returns the current voice processing config for VAD and volume gate.",content:`

getAudioSettings(): undefined | IOdinAudioSettings

Returns the current voice processing config for VAD and volume gate.

Returns

Type	Description
undefined \| IOdinAudioSettings

`}),e.add({id:806,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/getbasepeer/",title:"GetBasePeer",section:"ODIN Documentation",description:"",content:`

public PeerEntity GetBasePeer()

Returns

Type	Description
PeerEntity

`}),e.add({id:807,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/getbasepeer/",title:"GetBasePeer",section:"ODIN Documentation",description:"",content:`

public PeerEntity GetBasePeer()

Returns

Type	Description
PeerEntity

`}),e.add({id:808,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipeer/getbasepeer/",title:"GetBasePeer",section:"ODIN Documentation",description:"",content:`

PeerEntity GetBasePeer()

Get the underlying Odin

Returns

Type	Description
PeerEntity	native wrapper peer

`}),e.add({id:809,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/getbaseroom/",title:"GetBaseRoom",section:"ODIN Documentation",description:"",content:`

public Room GetBaseRoom()

Odin base room

Returns

Type	Description
Room	wrapper room object

`}),e.add({id:810,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getbaseroom/",title:"GetBaseRoom",section:"ODIN Documentation",description:"",content:`

public Room GetBaseRoom()

This will always return itself

Returns

Type	Description
Room

`}),e.add({id:811,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iroom/getbaseroom/",title:"GetBaseRoom",section:"ODIN Documentation",description:"",content:`

Room GetBaseRoom()

Get the underlying Room

Returns

Type	Description
Room	native wrapper room

`}),e.add({id:812,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getbinary/",title:"GetBinary",section:"ODIN Documentation",description:"",content:`

public byte[] GetBinary()

Returns

Type	Description
Byte[]

`}),e.add({id:813,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getbool/",title:"GetBool",section:"ODIN Documentation",description:"",content:`

public bool GetBool()

Returns

Type	Description
Boolean

`}),e.add({id:814,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/getbuffer/",title:"GetBuffer",section:"ODIN Documentation",description:"",content:`

public bool GetBuffer(out ArraySegment<byte> buffer)

Get raw bytes from the underlying stream buffer

Parameters

Name	Type	Description
buffer	ArraySegment<Byte>	underlying stream buffer

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:815,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/getbuffer/",title:"GetBuffer",section:"ODIN Documentation",description:"",content:`

bool GetBuffer(out ArraySegment<byte> buffer)

Parameters

Name	Type	Description
buffer	ArraySegment<Byte>

Returns

Type	Description
Boolean

`}),e.add({id:816,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getbyte/",title:"GetByte",section:"ODIN Documentation",description:"",content:`

public byte GetByte()

Returns

Type	Description
Byte

`}),e.add({id:817,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/getbytes/",title:"GetBytes",section:"ODIN Documentation",description:"",content:`

public byte[] GetBytes()

Get raw bytes from the stream buffer

Returns

Type	Description
Byte[]	Msgpack bytes

`}),e.add({id:818,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/getbytes/",title:"GetBytes",section:"ODIN Documentation",description:"",content:`

byte[] GetBytes()

Returns

Type	Description
Byte[]

`}),e.add({id:819,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/getdecoder/",title:"GetDecoder",section:"ODIN Documentation",description:"",content:`

public bool GetDecoder(ushort mediaId, out MediaDecoder decoder)

Get a output media by id.

Parameters

Name	Type	Description
mediaId	UInt16	decoder id
decoder	MediaDecoder	output media

Returns

Type	Description
Boolean	true on found or false

`}),e.add({id:820,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getdecoder/",title:"GetDecoder",section:"ODIN Documentation",description:"",content:`

public bool GetDecoder(ulong peerId, ushort mediaId, out MediaDecoder decoder)

Get a decoder from RemotePeers by id

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
decoder	MediaDecoder	output object or null

Returns

Type	Description
Boolean	true on decoder found or false

`}),e.add({id:821,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getdouble/",title:"GetDouble",section:"ODIN Documentation",description:"",content:`

public double GetDouble()

Returns

Type	Description
Double

`}),e.add({id:822,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/geteffect/",title:"GetEffect",section:"ODIN Documentation",description:"",content:`

public PiplineEffect GetEffect()

Returns

Type	Description
PiplineEffect

`}),e.add({id:823,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/geteffect/",title:"GetEffect",section:"ODIN Documentation",description:"",content:`

public virtual PiplineEffect GetEffect()

Get custom effect

Returns

Type	Description
PiplineEffect	custom effect

`}),e.add({id:824,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/geteffect/",title:"GetEffect",section:"ODIN Documentation",description:"",content:`

public PiplineEffect GetEffect()

Returns

Type	Description
PiplineEffect

`}),e.add({id:825,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iodineffect/geteffect/",title:"GetEffect",section:"ODIN Documentation",description:"",content:`

PiplineEffect GetEffect()

Returns

Type	Description
PiplineEffect

`}),e.add({id:826,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/geteffectcount/",title:"GetEffectCount",section:"ODIN Documentation",description:"",content:`

public uint GetEffectCount()

Get the current effect count of the native pipeline

Returns

Type	Description
UInt32	count of native registered effects

`}),e.add({id:827,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/geteffectid/",title:"GetEffectId",section:"ODIN Documentation",description:"",content:`

public uint GetEffectId(uint indexId)

Get the effect id of the native pipeline by index id

Parameters

Name	Type	Description
indexId	UInt32	index id

Returns

Type	Description
UInt32	effect id

`}),e.add({id:828,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/geteffectindex/",title:"GetEffectIndex",section:"ODIN Documentation",description:"",content:`

public virtual OdinError GetEffectIndex(out uint indexId)

Get native effect index

Parameters

Name	Type	Description
indexId	UInt32	native index

Returns

Type	Description
OdinError	or error

`}),e.add({id:829,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/geteffectindex/",title:"GetEffectIndex",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError GetEffectIndex(out uint indexId)

Get native effect index

Parameters

Name	Type	Description
indexId	UInt32	native index

Returns

Type	Description
OdinError	or error

`}),e.add({id:830,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/geteffects/",title:"GetEffects",section:"ODIN Documentation",description:"",content:`

public ILookup<uint, IPiplineEffect> GetEffects()

Get Pipeline effects collection

Returns

Type	Description
ILookup<UInt32,IPiplineEffect>	Get effects mapped by id

`}),e.add({id:831,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/geteffecttype/",title:"GetEffectType",section:"ODIN Documentation",description:"",content:`

public virtual OdinError GetEffectType(out NativeBindings.OdinEffectType effectType)

Get native effect NativeBindings

Parameters

Name	Type	Description
effectType	OdinEffectType	native type

Returns

Type	Description
OdinError	or error

`}),e.add({id:832,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/geteffecttype/",title:"GetEffectType",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError GetEffectType(out NativeBindings.OdinEffectType effectType)

Get native effect NativeBindings

Parameters

Name	Type	Description
effectType	OdinEffectType	native type

Returns

Type	Description
OdinError	or error

`}),e.add({id:833,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/geteffectuserdata/",title:"GetEffectUserData",section:"ODIN Documentation",description:"",content:`

public virtual U GetEffectUserData()

Get userdata used for the OdinCustomEffectUnityComponentBase%601

Returns

Type	Description
<U>	effect userdata

`}),e.add({id:834,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmuteaudiocomponent/geteffectuserdata/",title:"GetEffectUserData",section:"ODIN Documentation",description:"",content:`

public override IntPtr GetEffectUserData()

Returns

Type	Description
IntPtr

`}),e.add({id:835,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/geteffectuserdata/",title:"GetEffectUserData",section:"ODIN Documentation",description:"",content:`

public override OdinTerrainFilterComponent.TerrainFilterUserData GetEffectUserData()

Get delegate userdata

Returns

Type	Description
TerrainFilterUserData	effect userdata

`}),e.add({id:836,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getencoder/",title:"GetEncoder",section:"ODIN Documentation",description:"",content:`

public bool GetEncoder(ushort mediaId, out MediaEncoder encoder)

Get a encoder from Room by id

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
encoder	MediaEncoder	input object

Returns

Type	Description
Boolean	true on encoder found or false

`}),e.add({id:837,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IEnumerator<MediaStream> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<MediaStream>	enumerator

`}),e.add({id:838,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IEnumerator<Peer> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Peer>	enumerator

`}),e.add({id:839,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:840,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<MediaStream> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<MediaStream>	enumerator

`}),e.add({id:841,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Peer> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Peer>	enumerator

`}),e.add({id:842,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:843,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<MediaStream> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<MediaStream>	enumerator

`}),e.add({id:844,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Peer> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Peer>	enumerator

`}),e.add({id:845,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:846,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<MediaStream> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<MediaStream>	enumerator

`}),e.add({id:847,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Peer> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Peer>	enumerator

`}),e.add({id:848,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:849,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/arrayenumerable/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<MsgPackReader> GetEnumerator()

Returns

Type	Description
IEnumerator<MsgPackReader>

`}),e.add({id:850,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mapenumerable/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<KeyValuePair<string, MsgPackReader>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<MsgPackReader>>

`}),e.add({id:851,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:852,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<MediaStream> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<MediaStream>	enumerator

`}),e.add({id:853,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Peer> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Peer>	enumerator

`}),e.add({id:854,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/getenumerator/",title:"GetEnumerator",section:"ODIN Documentation",description:"",content:`

public IEnumerator<Room> GetEnumerator()

Get enumerator for iteration

Returns

Type	Description
IEnumerator<Room>	enumerator

`}),e.add({id:855,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getextension/",title:"GetExtension",section:"ODIN Documentation",description:"",content:`

public MessagePackExtension GetExtension()

Returns

Type	Description
MessagePackExtension

`}),e.add({id:856,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getfloat/",title:"GetFloat",section:"ODIN Documentation",description:"",content:`

public float GetFloat()

Returns

Type	Description
Single

`}),e.add({id:857,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getformatcode/",title:"GetFormatCode",section:"ODIN Documentation",description:"",content:`

public byte GetFormatCode()

Returns

Type	Description
Byte

`}),e.add({id:858,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/getformatname/",title:"GetFormatName",section:"ODIN Documentation",description:"",content:`

public static string GetFormatName(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
String

`}),e.add({id:859,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getformatname/",title:"GetFormatName",section:"ODIN Documentation",description:"",content:`

public string GetFormatName()

Returns

Type	Description
String

`}),e.add({id:860,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/getframebuffersize/",title:"GetFrameBufferSize",section:"ODIN Documentation",description:"",content:`

public virtual float GetFrameBufferSize()

Returns

Type	Description
Single

`}),e.add({id:861,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int GetHashCode(MediaStream obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	MediaStream	stream

Returns

Type	Description
Int32	hash code

`}),e.add({id:862,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int GetHashCode(Peer obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Peer	peer

Returns

Type	Description
Int32	hash code

`}),e.add({id:863,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:864,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(MediaStream obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	MediaStream	stream

Returns

Type	Description
Int32	hash code

`}),e.add({id:865,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Peer obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Peer	peer

Returns

Type	Description
Int32	hash code

`}),e.add({id:866,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:867,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(MediaStream obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	MediaStream	stream

Returns

Type	Description
Int32	hash code

`}),e.add({id:868,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Peer obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Peer	peer

Returns

Type	Description
Int32	hash code

`}),e.add({id:869,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:870,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(MediaStream obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	MediaStream	stream

Returns

Type	Description
Int32	hash code

`}),e.add({id:871,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Peer obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Peer	peer

Returns

Type	Description
Int32	hash code

`}),e.add({id:872,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:873,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:874,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(MediaStream obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	MediaStream	stream

Returns

Type	Description
Int32	hash code

`}),e.add({id:875,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Peer obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Peer	peer

Returns

Type	Description
Int32	hash code

`}),e.add({id:876,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/gethashcode/",title:"GetHashCode",section:"ODIN Documentation",description:"",content:`

public int GetHashCode(Room obj)

Default GetHashCode

Parameters

Name	Type	Description
obj	Room	room

Returns

Type	Description
Int32	hash code

`}),e.add({id:877,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/getinstance/",title:"GetInstance",section:"ODIN Documentation",description:"",content:`

public static ICustomMarshaler GetInstance(string cookie)

Parameters

Name	Type	Description
cookie	String

Returns

Type	Description
ICustomMarshaler

`}),e.add({id:878,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/getinstance/",title:"GetInstance",section:"ODIN Documentation",description:"",content:`

public static ICustomMarshaler GetInstance(string cookie)

Parameters

Name	Type	Description
cookie	String

Returns

Type	Description
ICustomMarshaler

`}),e.add({id:879,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getint/",title:"GetInt",section:"ODIN Documentation",description:"",content:`

public int GetInt()

Returns

Type	Description
Int32

`}),e.add({id:880,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/getlength/",title:"GetLength",section:"ODIN Documentation",description:"",content:`

public long GetLength()

Get raw bytes from the stream buffer

Returns

Type	Description
Int64	Msgpack buffer length

`}),e.add({id:881,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/getlength/",title:"GetLength",section:"ODIN Documentation",description:"",content:`

long GetLength()

Returns

Type	Description
Int64

`}),e.add({id:882,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getlong/",title:"GetLong",section:"ODIN Documentation",description:"",content:`

public long GetLong()

Returns

Type	Description
Int64

`}),e.add({id:883,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PlaybackStream GetMedia(string roomId, long mediaStreamId)

Get the PlaybackStream of a peer in the room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackStream	PlaybackStream or null

`}),e.add({id:884,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public PlaybackStream GetMedia(string roomId, long mediaStreamId)

Get the PlaybackStream of a peer in the room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackStream	PlaybackStream or null

`}),e.add({id:885,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public PlaybackStream GetMedia(string roomId, long mediaStreamId)

Get the PlaybackStream of a peer in the room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackStream	PlaybackStream or null

`}),e.add({id:886,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public PlaybackStream GetMedia(string roomId, long mediaStreamId)

Get the PlaybackStream of a peer in the room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackStream	PlaybackStream or null

`}),e.add({id:887,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public T GetMedia<T>()
    where T : IMedia

Returns

Type	Description
<T>

`}),e.add({id:888,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public virtual T GetMedia<T>()
    where T : IMedia

Get Media

Returns

Type	Description
<T>	Media

`}),e.add({id:889,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public T GetMedia<T>()
    where T : IMedia

Returns

Type	Description
<T>

`}),e.add({id:890,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iodineffect/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

T GetMedia<T>()
    where T : IMedia

Returns

Type	Description
<T>

`}),e.add({id:891,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getmedia/",title:"GetMedia",section:"ODIN Documentation",description:"",content:`

public PlaybackStream GetMedia(string roomId, long mediaStreamId)

Get the PlaybackStream of a peer in the room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackStream	PlaybackStream or null

`}),e.add({id:892,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/getmediabyid/",title:"getMediaById",section:"ODIN Documentation",description:"Returns the `OdinMedia` instance matching the specified ID.",content:`

getMediaById(id: number): undefined | OdinMedia

Returns the OdinMedia instance matching the specified ID.

Parameters

Name	Type	Description
id	number	The media ID to search for

Returns

Type	Description
undefined \| OdinMedia

`}),e.add({id:893,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/getmediaid/",title:"GetMediaId",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ushort GetMediaId()

Returns the media stream ID and updates Id.

Returns

Type	Description
UInt16	id value

`}),e.add({id:894,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/getmediaid/",title:"GetMediaId",section:"ODIN Documentation",description:"",content:`

public ushort GetMediaId()

Returns the media stream ID and updates Id.

Returns

Type	Description
UInt16	id value

`}),e.add({id:895,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/getmediaid/",title:"GetMediaId",section:"ODIN Documentation",description:"",content:`

public ushort GetMediaId()

Returns the media stream ID and updates Id.

Returns

Type	Description
UInt16	id value

`}),e.add({id:896,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/getmediaid/",title:"GetMediaId",section:"ODIN Documentation",description:"",content:`

public ushort GetMediaId()

Returns the media stream ID and updates Id.

Returns

Type	Description
UInt16	id value

`}),e.add({id:897,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/getmediaid/",title:"GetMediaId",section:"ODIN Documentation",description:"",content:`

public ushort GetMediaId()

Returns the media stream ID and updates Id.

Returns

Type	Description
UInt16	id value

`}),e.add({id:898,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/getmediastreamids/",title:"GetMediaStreamIds",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public List<long> GetMediaStreamIds()

Get a copy of all ids of Media from this peer

Returns

Type	Description
List<Int64>	MediaStreamIds

`}),e.add({id:899,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/getmediastreamids/",title:"GetMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public List<long> GetMediaStreamIds()

Get a copy of all ids of Media from this peer

Returns

Type	Description
List<Int64>	MediaStreamIds

`}),e.add({id:900,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/getmediastreamids/",title:"GetMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public List<long> GetMediaStreamIds()

Get a copy of all ids of Media from this peer

Returns

Type	Description
List<Int64>	MediaStreamIds

`}),e.add({id:901,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/getmediastreamids/",title:"GetMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public List<long> GetMediaStreamIds()

Get a copy of all ids of Media from this peer

Returns

Type	Description
List<Int64>	MediaStreamIds

`}),e.add({id:902,href:"https://www.4players.io/odin/sdk/unity/classes/peer/getmediastreamids/",title:"GetMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public List<long> GetMediaStreamIds()

Get a copy of all ids of Media from this peer

Returns

Type	Description
List<Int64>	MediaStreamIds

`}),e.add({id:903,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/getnativebuffer/",title:"GetNativeBuffer",section:"ODIN Documentation",description:"",content:`

public static byte[] GetNativeBuffer(IntPtr pointer, uint length)

Get Odin native buffer IntPtr data

Parameters

Name	Type	Description
pointer	IntPtr
length	UInt32

Returns

Type	Description
Byte[]

`}),e.add({id:904,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/getnativedatasize/",title:"GetNativeDataSize",section:"ODIN Documentation",description:"",content:`

public int GetNativeDataSize()

Returns

Type	Description
Int32

`}),e.add({id:905,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/getnativedatasize/",title:"GetNativeDataSize",section:"ODIN Documentation",description:"",content:`

public int GetNativeDataSize()

Returns

Type	Description
Int32

`}),e.add({id:906,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/getnextindex/",title:"GetNextIndex",section:"ODIN Documentation",description:"",content:`

public uint GetNextIndex()

Calculate the next available index based on MediaPipeline entries

Returns

Type	Description
UInt32	next available index

`}),e.add({id:907,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/getodinaudiostreamstats/",title:"GetOdinAudioStreamStats",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinAudioStreamStats GetOdinAudioStreamStats()

Returns

Type	Description
OdinAudioStreamStats

`}),e.add({id:908,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/getodinaudiostreamstats/",title:"GetOdinAudioStreamStats",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinAudioStreamStats GetOdinAudioStreamStats()

Returns

Type	Description
OdinAudioStreamStats

`}),e.add({id:909,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/getodinaudiostreamstats/",title:"GetOdinAudioStreamStats",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinAudioStreamStats GetOdinAudioStreamStats()

Returns

Type	Description
OdinAudioStreamStats

`}),e.add({id:910,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/getodinaudiostreamstats/",title:"GetOdinAudioStreamStats",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinAudioStreamStats GetOdinAudioStreamStats()

Returns

Type	Description
OdinAudioStreamStats

`}),e.add({id:911,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/getodindefault/",title:"GetOdinDefault",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static OdinRoomConfig GetOdinDefault()

Creates Apm OdinRoomConfig based on Odin

Returns

Type	Description
OdinRoomConfig	default Odin Apm Room Config

`}),e.add({id:912,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/getodindefault/",title:"GetOdinDefault",section:"ODIN Documentation",description:"",content:`

public static OdinRoomConfig GetOdinDefault()

Creates Apm OdinRoomConfig based on Odin

Returns

Type	Description
OdinRoomConfig	default Odin Apm Room Config

`}),e.add({id:913,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/getodindefault/",title:"GetOdinDefault",section:"ODIN Documentation",description:"",content:`

public static OdinRoomConfig GetOdinDefault()

Creates Apm OdinRoomConfig based on Odin

Returns

Type	Description
OdinRoomConfig	default Odin Apm Room Config

`}),e.add({id:914,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/getodindefault/",title:"GetOdinDefault",section:"ODIN Documentation",description:"",content:`

public static OdinRoomConfig GetOdinDefault()

Creates Apm OdinRoomConfig based on Odin

Returns

Type	Description
OdinRoomConfig	default Odin Apm Room Config

`}),e.add({id:915,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/getodindefault/",title:"GetOdinDefault",section:"ODIN Documentation",description:"",content:`

public static OdinRoomConfig GetOdinDefault()

Creates Apm OdinRoomConfig based on Odin

Returns

Type	Description
OdinRoomConfig	default Odin Apm Room Config

`}),e.add({id:916,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/getorcreatedecoder/",title:"GetOrCreateDecoder",section:"ODIN Documentation",description:"",content:`

public bool GetOrCreateDecoder(ushort mediaId, uint samplerate, bool stereo, out MediaDecoder decoder)

Get a output media by id. If the decoder is not found create a new one that will be added PeerEntity

Parameters

Name	Type	Description
mediaId	UInt16	decoder id
samplerate	UInt32	samplerate
stereo	Boolean	stereo flag
decoder	MediaDecoder	output media

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:917,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getorcreatedecoder/",title:"GetOrCreateDecoder",section:"ODIN Documentation",description:"",content:`

public bool GetOrCreateDecoder(ulong peerId, ushort mediaId, out MediaDecoder decoder)
public bool GetOrCreateDecoder(ulong peerId, ushort mediaId, uint samplerate, bool stereo, out MediaDecoder decoder)

Get a decoder from RemotePeers by id. If the decoder is not found create a new one that will be added to the Peer

Info

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
decoder	MediaDecoder	output object or null
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
Boolean	true on decoder found or false

Variants

GetOrCreateDecoder(peerId, mediaId, decoder)

public bool GetOrCreateDecoder(ulong peerId, ushort mediaId, out MediaDecoder decoder)

Get a decoder from RemotePeers by id. If the decoder is not found create a new one that will be added to the Peer

Warning

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
decoder	MediaDecoder	output object or null

Returns

Type	Description
Boolean	true on decoder found or false

GetOrCreateDecoder(peerId, mediaId, samplerate, stereo, decoder)

public bool GetOrCreateDecoder(ulong peerId, ushort mediaId, uint samplerate, bool stereo, out MediaDecoder decoder)

Get a decoder from RemotePeers by id. If the decoder is not found create a new one that will be added to the Peer

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of output media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag
decoder	MediaDecoder	output object or null

Returns

Type	Description
Boolean	true on decoder found or false

`}),e.add({id:918,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getorcreateencoder/",title:"GetOrCreateEncoder",section:"ODIN Documentation",description:"",content:`

public bool GetOrCreateEncoder(ushort mediaId, out MediaEncoder encoder)
public bool GetOrCreateEncoder(ushort mediaId, uint samplerate, bool stereo, out MediaEncoder encoder)

Get a encoder from Room.

Info

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
encoder	MediaEncoder	input object
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag

Returns

Type	Description
Boolean	true or false on error

Variants

GetOrCreateEncoder(mediaId, encoder)

public bool GetOrCreateEncoder(ushort mediaId, out MediaEncoder encoder)

Get a encoder from Room.

Warning

Will use the default samplerate and stereo flag set by the current room

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
encoder	MediaEncoder	input object

Returns

Type	Description
Boolean	true or false on error

GetOrCreateEncoder(mediaId, samplerate, stereo, encoder)

public bool GetOrCreateEncoder(ushort mediaId, uint samplerate, bool stereo, out MediaEncoder encoder)

Get a encoder from Room.

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
samplerate	UInt32	custom samplerate
stereo	Boolean	custom stereo flag
encoder	MediaEncoder	input object

Returns

Type	Description
Boolean	true or false on error

`}),e.add({id:919,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getorcreatemicrophonestream/",title:"GetOrCreateMicrophoneStream",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)

Returns the attached Audio

Parameters

Name	Type	Description
roomName	String	Room name
config	OdinMediaConfig	config

Returns

Type	Description
MicrophoneStream	or null if there is no room

`}),e.add({id:920,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getorcreatemicrophonestream/",title:"GetOrCreateMicrophoneStream",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)

Returns the attached Audio

Parameters

Name	Type	Description
roomName	String	Room name
config	OdinMediaConfig	config

Returns

Type	Description
MicrophoneStream	or null if there is no room

`}),e.add({id:921,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getorcreatemicrophonestream/",title:"GetOrCreateMicrophoneStream",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)

Returns the attached Audio

Parameters

Name	Type	Description
roomName	String	Room name
config	OdinMediaConfig	config

Returns

Type	Description
MicrophoneStream	or null if there is no room

`}),e.add({id:922,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getorcreatemicrophonestream/",title:"GetOrCreateMicrophoneStream",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)

Returns the attached Audio

Parameters

Name	Type	Description
roomName	String	Room name
config	OdinMediaConfig	config

Returns

Type	Description
MicrophoneStream	or null if there is no room

`}),e.add({id:923,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getorcreatemicrophonestream/",title:"GetOrCreateMicrophoneStream",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream GetOrCreateMicrophoneStream(string roomName, OdinMediaConfig config = null)

Returns the attached Audio

Parameters

Name	Type	Description
roomName	String	Room name
config	OdinMediaConfig	config

Returns

Type	Description
MicrophoneStream	or null if there is no room

`}),e.add({id:924,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getpeer/",title:"GetPeer",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer GetPeer(string roomId, ulong peerId)

Gets the a Peer object from a specified room matching a peer ID

Info

Local seen Peers only, not

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID

Returns

Type	Description
Peer	Peer or null

`}),e.add({id:925,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getpeer/",title:"GetPeer",section:"ODIN Documentation",description:"",content:`

public Peer GetPeer(string roomId, ulong peerId)

Gets the a Peer object from a specified room matching a peer ID

Info

Local seen Peers only, not

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID

Returns

Type	Description
Peer	Peer or null

`}),e.add({id:926,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getpeer/",title:"GetPeer",section:"ODIN Documentation",description:"",content:`

public Peer GetPeer(string roomId, ulong peerId)

Gets the a Peer object from a specified room matching a peer ID

Info

Local seen Peers only, not

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID

Returns

Type	Description
Peer	Peer or null

`}),e.add({id:927,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getpeer/",title:"GetPeer",section:"ODIN Documentation",description:"",content:`

public Peer GetPeer(string roomId, ulong peerId)

Gets the a Peer object from a specified room matching a peer ID

Info

Local seen Peers only, not

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID

Returns

Type	Description
Peer	Peer or null

`}),e.add({id:928,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getpeer/",title:"GetPeer",section:"ODIN Documentation",description:"",content:`

public Peer GetPeer(string roomId, ulong peerId)

Gets the a Peer object from a specified room matching a peer ID

Info

Local seen Peers only, not

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID

Returns

Type	Description
Peer	Peer or null

`}),e.add({id:929,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/getpeerbyid/",title:"getPeerById",section:"ODIN Documentation",description:"Returns the `OdinPeer` instance matching the specified ID.",content:`

getPeerById(id: number): undefined | OdinPeer

Returns the OdinPeer instance matching the specified ID.

Parameters

Name	Type	Description
id	number	The peer ID to search for

Returns

Type	Description
undefined \| OdinPeer

`}),e.add({id:930,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/getpeerid/",title:"GetPeerId",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong GetPeerId()

Returns the ID of the peer that own this media stream.

Returns

Type	Description
UInt64	id

`}),e.add({id:931,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/getpeerid/",title:"GetPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetPeerId()

Returns the ID of the peer that own this media stream.

Returns

Type	Description
UInt64	id

`}),e.add({id:932,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/getpeerid/",title:"GetPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetPeerId()

Returns the ID of the peer that own this media stream.

Returns

Type	Description
UInt64	id

`}),e.add({id:933,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/getpeerid/",title:"GetPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetPeerId()

Returns the ID of the peer that own this media stream.

Returns

Type	Description
UInt64	id

`}),e.add({id:934,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/getpeerid/",title:"GetPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetPeerId()

Returns the ID of the peer that own this media stream.

Returns

Type	Description
UInt64	id

`}),e.add({id:935,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getpeers/",title:"GetPeers",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)

Get all remote peers inside a room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
includeSelf	Boolean	optionally include Self in peers result

Returns

Type	Description
IEnumerable<Peer>	IEnumerable of RemotePeers

`}),e.add({id:936,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getpeers/",title:"GetPeers",section:"ODIN Documentation",description:"",content:`

public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)

Get all remote peers inside a room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
includeSelf	Boolean	optionally include Self in peers result

Returns

Type	Description
IEnumerable<Peer>	IEnumerable of RemotePeers

`}),e.add({id:937,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getpeers/",title:"GetPeers",section:"ODIN Documentation",description:"",content:`

public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)

Get all remote peers inside a room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
includeSelf	Boolean	optionally include Self in peers result

Returns

Type	Description
IEnumerable<Peer>	IEnumerable of RemotePeers

`}),e.add({id:938,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getpeers/",title:"GetPeers",section:"ODIN Documentation",description:"",content:`

public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)

Get all remote peers inside a room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
includeSelf	Boolean	optionally include Self in peers result

Returns

Type	Description
IEnumerable<Peer>	IEnumerable of RemotePeers

`}),e.add({id:939,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getpeers/",title:"GetPeers",section:"ODIN Documentation",description:"",content:`

public IEnumerable<Peer> GetPeers(string roomId, bool includeSelf = false)

Get all remote peers inside a room

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
includeSelf	Boolean	optionally include Self in peers result

Returns

Type	Description
IEnumerable<Peer>	IEnumerable of RemotePeers

`}),e.add({id:940,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/getpipeline/",title:"GetPipeline",section:"ODIN Documentation",description:"",content:`

public MediaPipeline GetPipeline()

Get native effect pipeline

Returns

Type	Description
MediaPipeline	managed effect pipeline

`}),e.add({id:941,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/getpipeline/",title:"GetPipeline",section:"ODIN Documentation",description:"",content:`

public MediaPipeline GetPipeline()

Get native effect pipeline

Returns

Type	Description
MediaPipeline	managed effect pipeline

`}),e.add({id:942,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/getpipeline/",title:"GetPipeline",section:"ODIN Documentation",description:"",content:`

public MediaPipeline GetPipeline()

Returns

Type	Description
MediaPipeline

`}),e.add({id:943,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imedia/getpipeline/",title:"GetPipeline",section:"ODIN Documentation",description:"",content:`

MediaPipeline GetPipeline()

Get native effect pipeline

Returns

Type	Description
MediaPipeline	managed effect pipeline

`}),e.add({id:944,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getplaybackcomponent/",title:"GetPlaybackComponent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)

Gets a Audio

Info

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent	PlaybackComponent or null

`}),e.add({id:945,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getplaybackcomponent/",title:"GetPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)

Gets a Audio

Info

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent	PlaybackComponent or null

`}),e.add({id:946,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getplaybackcomponent/",title:"GetPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)

Gets a Audio

Info

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent	PlaybackComponent or null

`}),e.add({id:947,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getplaybackcomponent/",title:"GetPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)

Gets a Audio

Info

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent	PlaybackComponent or null

`}),e.add({id:948,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getplaybackcomponent/",title:"GetPlaybackComponent",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent GetPlaybackComponent(string roomId, ulong peerId, long mediaStreamId)

Gets a Audio

Info

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent	PlaybackComponent or null

`}),e.add({id:949,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getplaybackcomponents/",title:"GetPlaybackComponents",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
peerId	UInt64	peer ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

`}),e.add({id:950,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getplaybackcomponents/",title:"GetPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
peerId	UInt64	peer ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

`}),e.add({id:951,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getplaybackcomponents/",title:"GetPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
peerId	UInt64	peer ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

`}),e.add({id:952,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getplaybackcomponents/",title:"GetPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
peerId	UInt64	peer ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

`}),e.add({id:953,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getplaybackcomponents/",title:"GetPlaybackComponents",section:"ODIN Documentation",description:"",content:`

public PlaybackComponent[] GetPlaybackComponents()
public PlaybackComponent[] GetPlaybackComponents(string roomId)
public PlaybackComponent[] GetPlaybackComponents(ulong peerId)
public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across all rooms

Info

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token
peerId	UInt64	peer ID
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

Variants

GetPlaybackComponents()

public PlaybackComponent[] GetPlaybackComponents()

Gets all Audio across all rooms

Warning

Simply uses FindObjectsOfType PlaybackComponent A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Returns

Type	Description
PlaybackComponent[]	The array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(roomId)

public PlaybackComponent[] GetPlaybackComponents(string roomId)

Gets all Audio filtered by room

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
roomId	String	Room identifier e.g name or token

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(peerId)

public PlaybackComponent[] GetPlaybackComponents(ulong peerId)

Gets all Audio across rooms filtered by peer

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
peerId	UInt64	peer ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

GetPlaybackComponents(mediaStreamId)

public PlaybackComponent[] GetPlaybackComponents(long mediaStreamId)

Gets all Audio across rooms filtered by media

Warning

A PlaybackComponent always have RoomName, PeerId and MediaId properties.

Parameters

Name	Type	Description
mediaStreamId	Int64	media handle ID

Returns

Type	Description
PlaybackComponent[]	The filtered array of objects found matching the type PlaybackComponent.

`}),e.add({id:954,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/getremotepeersids/",title:"GetRemotePeersIds",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public List<ulong> GetRemotePeersIds(bool includeSelf)

Get a copy of all PeerIds in this room

Parameters

Name	Type	Description
includeSelf	Boolean	to add the own peer id from the Joined event

Returns

Type	Description
List<UInt64>	PeerIds

`}),e.add({id:955,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getremotepeersids/",title:"GetRemotePeersIds",section:"ODIN Documentation",description:"",content:`

public List<ulong> GetRemotePeersIds(bool includeSelf)

Get a copy of all PeerIds in this room

Parameters

Name	Type	Description
includeSelf	Boolean	to add the own peer id from the Joined event

Returns

Type	Description
List<UInt64>	PeerIds

`}),e.add({id:956,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/getremotepeersids/",title:"GetRemotePeersIds",section:"ODIN Documentation",description:"",content:`

public List<ulong> GetRemotePeersIds(bool includeSelf)

Get a copy of all PeerIds in this room

Parameters

Name	Type	Description
includeSelf	Boolean	to add the own peer id from the Joined event

Returns

Type	Description
List<UInt64>	PeerIds

`}),e.add({id:957,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getremotepeersids/",title:"GetRemotePeersIds",section:"ODIN Documentation",description:"",content:`

public List<ulong> GetRemotePeersIds(bool includeSelf)

Get a copy of all PeerIds in this room

Parameters

Name	Type	Description
includeSelf	Boolean	to add the own peer id from the Joined event

Returns

Type	Description
List<UInt64>	PeerIds

`}),e.add({id:958,href:"https://www.4players.io/odin/sdk/unity/classes/room/getremotepeersids/",title:"GetRemotePeersIds",section:"ODIN Documentation",description:"",content:`

public List<ulong> GetRemotePeersIds(bool includeSelf)

Get a copy of all PeerIds in this room

Parameters

Name	Type	Description
includeSelf	Boolean	to add the own peer id from the Joined event

Returns

Type	Description
List<UInt64>	PeerIds

`}),e.add({id:959,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/getremotepeersmediastreamids/",title:"GetRemotePeersMediaStreamIds",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()

All ids of Media from remote peers in this room

Returns

Type	Description
ILookup<UInt64,IEnumerable<Int64>>	Lookup of PeerId, MediaStreamIds

`}),e.add({id:960,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getremotepeersmediastreamids/",title:"GetRemotePeersMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()

All ids of Media from remote peers in this room

Returns

Type	Description
ILookup<IEnumerable<Int64>>	Lookup of PeerId, MediaStreamIds

`}),e.add({id:961,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/getremotepeersmediastreamids/",title:"GetRemotePeersMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()

All ids of Media from remote peers in this room

Returns

Type	Description
ILookup<UInt64,IEnumerable<Int64>>	Lookup of PeerId, MediaStreamIds

`}),e.add({id:962,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getremotepeersmediastreamids/",title:"GetRemotePeersMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()

All ids of Media from remote peers in this room

Returns

Type	Description
ILookup<IEnumerable<Int64>>	Lookup of PeerId, MediaStreamIds

`}),e.add({id:963,href:"https://www.4players.io/odin/sdk/unity/classes/room/getremotepeersmediastreamids/",title:"GetRemotePeersMediaStreamIds",section:"ODIN Documentation",description:"",content:`

public ILookup<ulong, IEnumerable<long>> GetRemotePeersMediaStreamIds()

All ids of Media from remote peers in this room

Returns

Type	Description
ILookup<IEnumerable<Int64>>	Lookup of PeerId, MediaStreamIds

`}),e.add({id:964,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getroom/",title:"GetRoom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Room GetRoom(string id)

Gets the room object from Odin

Parameters

Name	Type	Description
id	String	Room identifier e.g name or token

Returns

Type	Description
Room	Room or null

`}),e.add({id:965,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getroom/",title:"GetRoom",section:"ODIN Documentation",description:"",content:`

public Room GetRoom(string id)

Gets the room object from Odin

Parameters

Name	Type	Description
id	String	Room identifier e.g name or token

Returns

Type	Description
Room	Room or null

`}),e.add({id:966,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getroom/",title:"GetRoom",section:"ODIN Documentation",description:"",content:`

public Room GetRoom(string id)

Gets the room object from Odin

Parameters

Name	Type	Description
id	String	Room identifier e.g name or token

Returns

Type	Description
Room	Room or null

`}),e.add({id:967,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getroom/",title:"GetRoom",section:"ODIN Documentation",description:"",content:`

public Room GetRoom(string id)

Gets the room object from Odin

Parameters

Name	Type	Description
id	String	Room identifier e.g name or token

Returns

Type	Description
Room	Room or null

`}),e.add({id:968,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getroom/",title:"GetRoom",section:"ODIN Documentation",description:"",content:`

public Room GetRoom(string id)

Gets the room object from Odin

Parameters

Name	Type	Description
id	String	Room identifier e.g name or token

Returns

Type	Description
Room	Room or null

`}),e.add({id:969,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/getroomapi/",title:"GetRoomApi",section:"ODIN Documentation",description:"",content:`

public Room GetRoomApi()

Returns

Type	Description
Room

`}),e.add({id:970,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/getroomapi/",title:"GetRoomApi",section:"ODIN Documentation",description:"",content:`

public Room GetRoomApi()

Returns

Type	Description
Room

`}),e.add({id:971,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipeer/getroomapi/",title:"GetRoomApi",section:"ODIN Documentation",description:"",content:`

Room GetRoomApi()

Get the underlying Room

Returns

Type	Description
Room	native wrapper room

`}),e.add({id:972,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getroomconnectionstats/",title:"GetRoomConnectionStats",section:"ODIN Documentation",description:"",content:`

public OdinConnectionStats GetRoomConnectionStats()

Retrieves statistics for the underlying connection of this room

Info

The room has to be in a joined state

Returns

Type	Description
OdinConnectionStats	Statistics for the underlying connection of this room

`}),e.add({id:973,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getroomconnectionstats/",title:"GetRoomConnectionStats",section:"ODIN Documentation",description:"",content:`

public OdinConnectionStats GetRoomConnectionStats()

Retrieves statistics for the underlying connection of this room

Info

The room has to be in a joined state

Returns

Type	Description
OdinConnectionStats	Statistics for the underlying connection of this room

`}),e.add({id:974,href:"https://www.4players.io/odin/sdk/unity/classes/room/getroomconnectionstats/",title:"GetRoomConnectionStats",section:"ODIN Documentation",description:"",content:`

public OdinConnectionStats GetRoomConnectionStats()

Retrieves statistics for the underlying connection of this room

Info

The room has to be in a joined state

Returns

Type	Description
OdinConnectionStats	Statistics for the underlying connection of this room

`}),e.add({id:975,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/getroomcustomer/",title:"GetRoomCustomer",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string GetRoomCustomer()

Retrieves the identifier of the customer the room

Returns

Type	Description
String	customer

`}),e.add({id:976,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getroomcustomer/",title:"GetRoomCustomer",section:"ODIN Documentation",description:"",content:`

public string GetRoomCustomer()

Retrieves the identifier of the customer the room

Returns

Type	Description
String	customer

`}),e.add({id:977,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/getroomcustomer/",title:"GetRoomCustomer",section:"ODIN Documentation",description:"",content:`

public string GetRoomCustomer()

Retrieves the identifier of the customer the room

Returns

Type	Description
String	customer

`}),e.add({id:978,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getroomcustomer/",title:"GetRoomCustomer",section:"ODIN Documentation",description:"",content:`

public string GetRoomCustomer()

Retrieves the identifier of the customer the room

Returns

Type	Description
String	customer

`}),e.add({id:979,href:"https://www.4players.io/odin/sdk/unity/classes/room/getroomcustomer/",title:"GetRoomCustomer",section:"ODIN Documentation",description:"",content:`

public string GetRoomCustomer()

Retrieves the identifier of the customer the room

Returns

Type	Description
String	customer

`}),e.add({id:980,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string GetRoomId()

Retrieves the room ID (e.g. the name of the room)

Returns

Type	Description
String	room name

`}),e.add({id:981,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

public string GetRoomId()

Retrieves the room ID (e.g. the name of the room)

Returns

Type	Description
String	room name

`}),e.add({id:982,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

public string GetRoomId()

Retrieves the room ID (e.g. the name of the room)

Returns

Type	Description
String	room name

`}),e.add({id:983,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

public string GetRoomId()

Retrieves the room ID (e.g. the name of the room)

Returns

Type	Description
String	room name

`}),e.add({id:984,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

public ulong GetRoomId()

Retrieves the room id

Returns

Type	Description
UInt64	room id

`}),e.add({id:985,href:"https://www.4players.io/odin/sdk/unity/classes/room/getroomid/",title:"GetRoomId",section:"ODIN Documentation",description:"",content:`

public string GetRoomId()

Retrieves the room ID (e.g. the name of the room)

Returns

Type	Description
String	room name

`}),e.add({id:986,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/getroompeerid/",title:"GetRoomPeerId",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong GetRoomPeerId()

Retrieves your own peer ID

Returns

Type	Description
UInt64	peer id

`}),e.add({id:987,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/getroompeerid/",title:"GetRoomPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetRoomPeerId()

Retrieves your own peer ID

Returns

Type	Description
UInt64	peer id

`}),e.add({id:988,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/getroompeerid/",title:"GetRoomPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetRoomPeerId()

Retrieves your own peer ID

Returns

Type	Description
UInt64	peer id

`}),e.add({id:989,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/getroompeerid/",title:"GetRoomPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetRoomPeerId()

Retrieves your own peer ID

Returns

Type	Description
UInt64	peer id

`}),e.add({id:990,href:"https://www.4players.io/odin/sdk/unity/classes/room/getroompeerid/",title:"GetRoomPeerId",section:"ODIN Documentation",description:"",content:`

public ulong GetRoomPeerId()

Retrieves your own peer ID

Returns

Type	Description
UInt64	peer id

`}),e.add({id:991,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/getsamples/",title:"GetSamples",section:"ODIN Documentation",description:"",content:`

public float[] GetSamples()
public void GetSamples(out float[] buffer)
public void GetSamples(ref float[] buffer, int index = 0)

Parameters

Name	Type	Description
buffer	Single[]
index	Int32

Returns

Type	Description
Single[]

Variants

GetSamples()

public float[] GetSamples()

Returns

Type	Description
Single[]

GetSamples(buffer)

public void GetSamples(out float[] buffer)

Parameters

Name	Type	Description
buffer	Single[]

GetSamples(buffer, index)

public void GetSamples(ref float[] buffer, int index = 0)

Parameters

Name	Type	Description
buffer	Single[]
index	Int32

`}),e.add({id:992,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getsbyte/",title:"GetSByte",section:"ODIN Documentation",description:"",content:`

public sbyte GetSByte()

Returns

Type	Description
SByte

`}),e.add({id:993,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getshort/",title:"GetShort",section:"ODIN Documentation",description:"",content:`

public short GetShort()

Returns

Type	Description
Int16

`}),e.add({id:994,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/getsourcetype/",title:"GetSourceType",section:"ODIN Documentation",description:"",content:`

public static byte GetSourceType(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Byte

`}),e.add({id:995,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getstring/",title:"GetString",section:"ODIN Documentation",description:"",content:`

public string GetString()

Returns

Type	Description
String

`}),e.add({id:996,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/gettimestamp/",title:"GetTimestamp",section:"ODIN Documentation",description:"",content:`

public DateTime GetTimestamp()

Returns

Type	Description
DateTime

`}),e.add({id:997,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getuint/",title:"GetUInt",section:"ODIN Documentation",description:"",content:`

public uint GetUInt()

Returns

Type	Description
UInt32

`}),e.add({id:998,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getulong/",title:"GetULong",section:"ODIN Documentation",description:"",content:`

public ulong GetULong()

Returns

Type	Description
UInt64

`}),e.add({id:999,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/getuserdata/",title:"GetUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IUserData GetUserData()

Returns

Type	Description
IUserData

`}),e.add({id:1e3,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/getuserdata/",title:"GetUserData",section:"ODIN Documentation",description:"",content:`

public IUserData GetUserData()

Returns

Type	Description
IUserData

`}),e.add({id:1001,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/getuserdata/",title:"GetUserData",section:"ODIN Documentation",description:"",content:`

public IUserData GetUserData()

Returns

Type	Description
IUserData

`}),e.add({id:1002,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/getuserdata/",title:"GetUserData",section:"ODIN Documentation",description:"",content:`

public IUserData GetUserData()

Returns

Type	Description
IUserData

`}),e.add({id:1003,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/getuserdata/",title:"GetUserData",section:"ODIN Documentation",description:"",content:`

public IUserData GetUserData()

Returns

Type	Description
IUserData

`}),e.add({id:1004,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/getushort/",title:"GetUShort",section:"ODIN Documentation",description:"",content:`

public ushort GetUShort()

Returns

Type	Description
UInt16

`}),e.add({id:1005,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/getvadconfig/",title:"GetVadConfig",section:"ODIN Documentation",description:"",content:`

public override OdinError GetVadConfig(out OdinVadConfig config)

Not supported

Parameters

Name	Type	Description
config	OdinVadConfig

Returns

Type	Description
OdinError

`}),e.add({id:1006,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/getvadconfig/",title:"GetVadConfig",section:"ODIN Documentation",description:"",content:`

public virtual OdinError GetVadConfig(out NativeBindings.OdinVadConfig config)

Get native voice activity config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinVadConfig	native config

Returns

Type	Description
OdinError	or error

`}),e.add({id:1007,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/getvadconfig/",title:"GetVadConfig",section:"ODIN Documentation",description:"",content:`

public OdinVadConfig GetVadConfig()

Get native voice activity configuration

Returns

Type	Description
OdinVadConfig	updated config

`}),e.add({id:1008,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/getvadconfig/",title:"GetVadConfig",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError GetVadConfig(out NativeBindings.OdinVadConfig config)

Get native voice activity config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinVadConfig	native config

Returns

Type	Description
OdinError	or error

`}),e.add({id:1009,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/guardsilence/",title:"GuardSilence",section:"ODIN Documentation",description:" On true isSilent = true will not push data to the native encoder ",content:`

public bool GuardSilence { get; set; }

On true Single%5b%5d%2cSystem

isSilent = true

will not push data to the native encoder

Info

On true always returns OdinError

Value Type

Type	Description
Boolean

`}),e.add({id:1010,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/handle/",title:"Handle",section:"ODIN Documentation",description:" Odin connection ",content:`

public OdinConnectionPoolHandle Handle { get; }

Odin connection

Value Type

Type	Description
OdinConnectionPoolHandle

`}),e.add({id:1011,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/hasactivity/",title:"HasActivity",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HasActivity { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1012,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/hasactivity/",title:"HasActivity",section:"ODIN Documentation",description:"",content:`

public bool HasActivity { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1013,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/hasactivity/",title:"HasActivity",section:"ODIN Documentation",description:"",content:`

public bool HasActivity { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1014,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/hasactivity/",title:"HasActivity",section:"ODIN Documentation",description:"",content:`

public bool HasActivity { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1015,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/hasactivity/",title:"HasActivity",section:"ODIN Documentation",description:"",content:`

public bool HasActivity { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1016,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/hasconnections/",title:"HasConnections",section:"ODIN Documentation",description:" True if any is joined ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HasConnections { get; }

True if any Room is joined

Value Type

Type	Description
Boolean

`}),e.add({id:1017,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/hasconnections/",title:"HasConnections",section:"ODIN Documentation",description:" True if any is joined ",content:`

public bool HasConnections { get; }

True if any Room is joined

Value Type

Type	Description
Boolean

`}),e.add({id:1018,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/hasconnections/",title:"HasConnections",section:"ODIN Documentation",description:" True if any is joined ",content:`

public bool HasConnections { get; }

True if any Room is joined

Value Type

Type	Description
Boolean

`}),e.add({id:1019,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/hasconnections/",title:"HasConnections",section:"ODIN Documentation",description:" True if any is joined ",content:`

public bool HasConnections { get; }

True if any Room is joined

Value Type

Type	Description
Boolean

`}),e.add({id:1020,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/hasconnections/",title:"HasConnections",section:"ODIN Documentation",description:" True if any is joined ",content:`

public bool HasConnections { get; }

True if any Room is joined

Value Type

Type	Description
Boolean

`}),e.add({id:1021,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/haserrors/",title:"HasErrors",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HasErrors { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1022,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/haserrors/",title:"HasErrors",section:"ODIN Documentation",description:" Indicates wether or not the last media stream api call result is an error code ",content:`

public bool HasErrors { get; }

Indicates wether or not the last media stream api call result is an error code

Value Type

Type	Description
Boolean

`}),e.add({id:1023,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/haserrors/",title:"HasErrors",section:"ODIN Documentation",description:"",content:`

public bool HasErrors { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1024,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/haserrors/",title:"HasErrors",section:"ODIN Documentation",description:" Indicates wether or not the last media stream api call result is an error code ",content:`

public bool HasErrors { get; }

Indicates wether or not the last media stream api call result is an error code

Value Type

Type	Description
Boolean

`}),e.add({id:1025,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/haserrors/",title:"HasErrors",section:"ODIN Documentation",description:" Indicates wether or not the last media stream api call result is an error code ",content:`

public bool HasErrors { get; }

Indicates wether or not the last media stream api call result is an error code

Value Type

Type	Description
Boolean

`}),e.add({id:1026,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/haseventcallbacks/",title:"HasEventCallbacks",section:"ODIN Documentation",description:" true if where set and registered in ODIN ffi ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HasEventCallbacks

true if Room where set and registered in ODIN ffi

Value Type

Type	Description
Boolean

`}),e.add({id:1027,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/haseventcallbacks/",title:"HasEventCallbacks",section:"ODIN Documentation",description:" true if where set and registered in ODIN ffi ",content:`

public bool HasEventCallbacks

true if Room where set and registered in ODIN ffi

Value Type

Type	Description
Boolean

`}),e.add({id:1028,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/haseventcallbacks/",title:"HasEventCallbacks",section:"ODIN Documentation",description:" true if where set and registered in ODIN ffi ",content:`

public bool HasEventCallbacks

true if Room where set and registered in ODIN ffi

Value Type

Type	Description
Boolean

`}),e.add({id:1029,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/haseventcallbacks/",title:"HasEventCallbacks",section:"ODIN Documentation",description:" true if where set and registered in ODIN ffi ",content:`

public bool HasEventCallbacks

true if Room where set and registered in ODIN ffi

Value Type

Type	Description
Boolean

`}),e.add({id:1030,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/haseventcallbacks/",title:"HasEventCallbacks",section:"ODIN Documentation",description:" true if where set and registered in ODIN ffi ",content:`

public bool HasEventCallbacks

true if Room where set and registered in ODIN ffi

Value Type

Type	Description
Boolean

`}),e.add({id:1031,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1032,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1033,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1034,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1035,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1036,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/haspermission/",title:"HasPermission",section:"ODIN Documentation",description:" Check if the user has authorized use of the microphone ",content:`

public bool HasPermission { get; }

Check if the user has authorized use of the microphone

Info

In other build targets except for Web Player, this function will always return true.

Value Type

Type	Description
Boolean

`}),e.add({id:1037,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/high/",title:"High",section:"ODIN Documentation",description:" 18 dB ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

High = 3

18 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1038,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/high/",title:"High",section:"ODIN Documentation",description:" 18 dB ",content:`

High = 3

18 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1039,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/high/",title:"High",section:"ODIN Documentation",description:" 18 dB ",content:`

High = 3

18 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1040,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/high/",title:"High",section:"ODIN Documentation",description:" 18 dB ",content:`

High = 3

18 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1041,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/high/",title:"High",section:"ODIN Documentation",description:" 18 dB ",content:`

High = 3

18 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1042,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/high_pass_filter/",title:"high_pass_filter",section:"ODIN Documentation",description:"",content:`

public bool high_pass_filter

Value Type

Type	Description
Boolean

`}),e.add({id:1043,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/highpassfilter/",title:"highPassFilter",section:"ODIN Documentation",description:"Enable or disable high pass filtering",content:`

public highPassFilter: boolean

Enable or disable high pass filtering

`}),e.add({id:1044,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1045,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Reduces lower frequencies of the input (Automatic game control) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HighPassFilter

Reduces lower frequencies of the input (Automatic game control)

Value Type

Type	Description
Boolean

`}),e.add({id:1046,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Enable or disable high pass filtering ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool HighPassFilter { get; set; }

Enable or disable high pass filtering

Value Type

Type	Description
Boolean

`}),e.add({id:1047,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1048,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Reduces lower frequencies of the input (Automatic game control) ",content:`

public bool HighPassFilter

Reduces lower frequencies of the input (Automatic game control)

Value Type

Type	Description
Boolean

`}),e.add({id:1049,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Enable or disable high pass filtering ",content:`

public bool HighPassFilter { get; set; }

Enable or disable high pass filtering

Value Type

Type	Description
Boolean

`}),e.add({id:1050,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1051,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Reduces lower frequencies of the input (Automatic game control) ",content:`

public bool HighPassFilter

Reduces lower frequencies of the input (Automatic game control)

Value Type

Type	Description
Boolean

`}),e.add({id:1052,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Enable or disable high pass filtering ",content:`

public bool HighPassFilter { get; set; }

Enable or disable high pass filtering

Value Type

Type	Description
Boolean

`}),e.add({id:1053,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1054,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Reduces lower frequencies of the input (Automatic game control) ",content:`

public bool HighPassFilter

Reduces lower frequencies of the input (Automatic game control)

Value Type

Type	Description
Boolean

`}),e.add({id:1055,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Enable or disable high pass filtering ",content:`

public bool HighPassFilter { get; set; }

Enable or disable high pass filtering

Value Type

Type	Description
Boolean

`}),e.add({id:1056,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled ",content:`

public bool HighPassFilter { get; set; }

Idicates whether the ApmConfig setting is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:1057,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:"",content:`

public bool HighPassFilter

Value Type

Type	Description
Boolean

`}),e.add({id:1058,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1059,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool HighPassFilter

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1060,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Reduces lower frequencies of the input (Automatic game control) ",content:`

public bool HighPassFilter

Reduces lower frequencies of the input (Automatic game control)

Value Type

Type	Description
Boolean

`}),e.add({id:1061,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/highpassfilter/",title:"HighPassFilter",section:"ODIN Documentation",description:" Enable or disable high pass filtering ",content:`

public bool HighPassFilter { get; set; }

Enable or disable high pass filtering

Value Type

Type	Description
Boolean

`}),e.add({id:1062,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz11025/",title:"Hz11025",section:"ODIN Documentation",description:" 11.025khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz11025 = 11025U

11.025khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1063,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz11025/",title:"Hz11025",section:"ODIN Documentation",description:" 11.025khz ",content:`

Hz11025 = 11025U

11.025khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1064,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz11025/",title:"Hz11025",section:"ODIN Documentation",description:" 11.025khz ",content:`

Hz11025 = 11025U

11.025khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1065,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz11025/",title:"Hz11025",section:"ODIN Documentation",description:" 11.025khz ",content:`

Hz11025 = 11025U

11.025khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1066,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz11025/",title:"Hz11025",section:"ODIN Documentation",description:" 11.025khz ",content:`

Hz11025 = 11025U

11.025khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1067,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz12000/",title:"Hz12000",section:"ODIN Documentation",description:" 12khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz12000 = 12000U

12khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1068,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz12000/",title:"Hz12000",section:"ODIN Documentation",description:" 12khz ",content:`

Hz12000 = 12000U

12khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1069,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz12000/",title:"Hz12000",section:"ODIN Documentation",description:" 12khz ",content:`

Hz12000 = 12000U

12khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1070,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz12000/",title:"Hz12000",section:"ODIN Documentation",description:" 12khz ",content:`

Hz12000 = 12000U

12khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1071,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz12000/",title:"Hz12000",section:"ODIN Documentation",description:" 12khz ",content:`

Hz12000 = 12000U

12khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1072,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz128000/",title:"Hz128000",section:"ODIN Documentation",description:" 128khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz128000 = 128000U

128khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1073,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz128000/",title:"Hz128000",section:"ODIN Documentation",description:" 128khz ",content:`

Hz128000 = 128000U

128khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1074,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz128000/",title:"Hz128000",section:"ODIN Documentation",description:" 128khz ",content:`

Hz128000 = 128000U

128khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1075,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz128000/",title:"Hz128000",section:"ODIN Documentation",description:" 128khz ",content:`

Hz128000 = 128000U

128khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1076,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz128000/",title:"Hz128000",section:"ODIN Documentation",description:" 128khz ",content:`

Hz128000 = 128000U

128khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1077,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz144000/",title:"Hz144000",section:"ODIN Documentation",description:" 144khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz144000 = 144000U

144khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1078,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz144000/",title:"Hz144000",section:"ODIN Documentation",description:" 144khz ",content:`

Hz144000 = 144000U

144khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1079,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz144000/",title:"Hz144000",section:"ODIN Documentation",description:" 144khz ",content:`

Hz144000 = 144000U

144khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1080,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz144000/",title:"Hz144000",section:"ODIN Documentation",description:" 144khz ",content:`

Hz144000 = 144000U

144khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1081,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz144000/",title:"Hz144000",section:"ODIN Documentation",description:" 144khz ",content:`

Hz144000 = 144000U

144khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1082,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz16000/",title:"Hz16000",section:"ODIN Documentation",description:" 16khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz16000 = 16000U

16khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1083,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz16000/",title:"Hz16000",section:"ODIN Documentation",description:" 16khz ",content:`

Hz16000 = 16000U

16khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1084,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz16000/",title:"Hz16000",section:"ODIN Documentation",description:" 16khz ",content:`

Hz16000 = 16000U

16khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1085,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz16000/",title:"Hz16000",section:"ODIN Documentation",description:" 16khz ",content:`

Hz16000 = 16000U

16khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1086,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz16000/",title:"Hz16000",section:"ODIN Documentation",description:" 16khz ",content:`

Hz16000 = 16000U

16khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1087,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz192000/",title:"Hz192000",section:"ODIN Documentation",description:" 192khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz192000 = 192000U

192khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1088,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz192000/",title:"Hz192000",section:"ODIN Documentation",description:" 192khz ",content:`

Hz192000 = 192000U

192khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1089,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz192000/",title:"Hz192000",section:"ODIN Documentation",description:" 192khz ",content:`

Hz192000 = 192000U

192khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1090,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz192000/",title:"Hz192000",section:"ODIN Documentation",description:" 192khz ",content:`

Hz192000 = 192000U

192khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1091,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz192000/",title:"Hz192000",section:"ODIN Documentation",description:" 192khz ",content:`

Hz192000 = 192000U

192khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1092,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz22050/",title:"Hz22050",section:"ODIN Documentation",description:" 22.05khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz22050 = 22050U

22.05khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1093,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz22050/",title:"Hz22050",section:"ODIN Documentation",description:" 22.05khz ",content:`

Hz22050 = 22050U

22.05khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1094,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz22050/",title:"Hz22050",section:"ODIN Documentation",description:" 22.05khz ",content:`

Hz22050 = 22050U

22.05khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1095,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz22050/",title:"Hz22050",section:"ODIN Documentation",description:" 22.05khz ",content:`

Hz22050 = 22050U

22.05khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1096,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz22050/",title:"Hz22050",section:"ODIN Documentation",description:" 22.05khz ",content:`

Hz22050 = 22050U

22.05khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1097,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz24000/",title:"Hz24000",section:"ODIN Documentation",description:" 24khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz24000 = 24000U

24khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1098,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz24000/",title:"Hz24000",section:"ODIN Documentation",description:" 24khz ",content:`

Hz24000 = 24000U

24khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1099,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz24000/",title:"Hz24000",section:"ODIN Documentation",description:" 24khz ",content:`

Hz24000 = 24000U

24khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1100,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz24000/",title:"Hz24000",section:"ODIN Documentation",description:" 24khz ",content:`

Hz24000 = 24000U

24khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1101,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz24000/",title:"Hz24000",section:"ODIN Documentation",description:" 24khz ",content:`

Hz24000 = 24000U

24khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1102,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz32000/",title:"Hz32000",section:"ODIN Documentation",description:" 32khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz32000 = 32000U

32khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1103,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz32000/",title:"Hz32000",section:"ODIN Documentation",description:" 32khz ",content:`

Hz32000 = 32000U

32khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1104,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz32000/",title:"Hz32000",section:"ODIN Documentation",description:" 32khz ",content:`

Hz32000 = 32000U

32khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1105,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz32000/",title:"Hz32000",section:"ODIN Documentation",description:" 32khz ",content:`

Hz32000 = 32000U

32khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1106,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz32000/",title:"Hz32000",section:"ODIN Documentation",description:" 32khz ",content:`

Hz32000 = 32000U

32khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1107,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz44100/",title:"Hz44100",section:"ODIN Documentation",description:" 44.1khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz44100 = 44100U

44.1khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1108,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz44100/",title:"Hz44100",section:"ODIN Documentation",description:" 44.1khz ",content:`

Hz44100 = 44100U

44.1khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1109,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz44100/",title:"Hz44100",section:"ODIN Documentation",description:" 44.1khz ",content:`

Hz44100 = 44100U

44.1khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1110,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz44100/",title:"Hz44100",section:"ODIN Documentation",description:" 44.1khz ",content:`

Hz44100 = 44100U

44.1khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1111,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz44100/",title:"Hz44100",section:"ODIN Documentation",description:" 44.1khz ",content:`

Hz44100 = 44100U

44.1khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1112,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz48000/",title:"Hz48000",section:"ODIN Documentation",description:" 48khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz48000 = 48000U

48khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1113,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz48000/",title:"Hz48000",section:"ODIN Documentation",description:" 48khz ",content:`

Hz48000 = 48000U

48khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1114,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz48000/",title:"Hz48000",section:"ODIN Documentation",description:" 48khz ",content:`

Hz48000 = 48000U

48khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1115,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz48000/",title:"Hz48000",section:"ODIN Documentation",description:" 48khz ",content:`

Hz48000 = 48000U

48khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1116,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz48000/",title:"Hz48000",section:"ODIN Documentation",description:" 48khz ",content:`

Hz48000 = 48000U

48khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1117,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz8000/",title:"Hz8000",section:"ODIN Documentation",description:" 8khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz8000 = 8000U

8khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1118,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz8000/",title:"Hz8000",section:"ODIN Documentation",description:" 8khz ",content:`

Hz8000 = 8000U

8khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1119,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz8000/",title:"Hz8000",section:"ODIN Documentation",description:" 8khz ",content:`

Hz8000 = 8000U

8khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1120,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz8000/",title:"Hz8000",section:"ODIN Documentation",description:" 8khz ",content:`

Hz8000 = 8000U

8khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1121,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz8000/",title:"Hz8000",section:"ODIN Documentation",description:" 8khz ",content:`

Hz8000 = 8000U

8khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1122,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/hz96000/",title:"Hz96000",section:"ODIN Documentation",description:" 96khz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Hz96000 = 96000U

96khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1123,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/hz96000/",title:"Hz96000",section:"ODIN Documentation",description:" 96khz ",content:`

Hz96000 = 96000U

96khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1124,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/hz96000/",title:"Hz96000",section:"ODIN Documentation",description:" 96khz ",content:`

Hz96000 = 96000U

96khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1125,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/hz96000/",title:"Hz96000",section:"ODIN Documentation",description:" 96khz ",content:`

Hz96000 = 96000U

96khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1126,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/hz96000/",title:"Hz96000",section:"ODIN Documentation",description:" 96khz ",content:`

Hz96000 = 96000U

96khz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:1127,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/id/",title:"id",section:"ODIN Documentation",description:"Gets the ID of the media.",content:`

public id: string

Gets the ID of the media.

`}),e.add({id:1128,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/id/",title:"id",section:"ODIN Documentation",description:"Gets the ID of the room.",content:`

public id: string

Gets the ID of the room.

`}),e.add({id:1129,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/id/",title:"id",section:"ODIN Documentation",description:"The ID of the media.",content:`

number

The ID of the media.

`}),e.add({id:1130,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/id/",title:"id",section:"ODIN Documentation",description:"The ID of the peer.",content:`

number

The ID of the peer.

`}),e.add({id:1131,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/id/",title:"id",section:"ODIN Documentation",description:"The ID of the room.",content:`

string

The ID of the room.

`}),e.add({id:1132,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/id/",title:"Id",section:"ODIN Documentation",description:" Handle ID ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public long Id { get; }

Handle ID

Value Type

Type	Description
Int64

`}),e.add({id:1133,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1134,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/id/",title:"Id",section:"ODIN Documentation",description:" Handle ID ",content:`

public long Id { get; }

Handle ID

Value Type

Type	Description
Int64

`}),e.add({id:1135,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1136,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/id/",title:"Id",section:"ODIN Documentation",description:" Handle ID ",content:`

public long Id { get; }

Handle ID

Value Type

Type	Description
Int64

`}),e.add({id:1137,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1138,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/id/",title:"Id",section:"ODIN Documentation",description:" Handle ID ",content:`

public long Id { get; }

Handle ID

Value Type

Type	Description
Int64

`}),e.add({id:1139,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1140,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/id/",title:"Id",section:"ODIN Documentation",description:" Media id ",content:`

public ushort Id { get; }

Media id

Value Type

Type	Description
UInt16

`}),e.add({id:1141,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/id/",title:"Id",section:"ODIN Documentation",description:" Media id ",content:`

public ushort Id { get; }

Media id

Value Type

Type	Description
UInt16

`}),e.add({id:1142,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/id/",title:"Id",section:"ODIN Documentation",description:"",content:`

public ushort Id { get; }

Value Type

Type	Description
UInt16

`}),e.add({id:1143,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/id/",title:"Id",section:"ODIN Documentation",description:"",content:`

public ulong Id { get; set; }

Value Type

Type	Description
UInt64

`}),e.add({id:1144,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/id/",title:"Id",section:"ODIN Documentation",description:" Odin room id ",content:`

public ulong Id { get; }

Odin room id

Value Type

Type	Description
UInt64

`}),e.add({id:1145,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1146,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/id/",title:"Id",section:"ODIN Documentation",description:" Effect id ",content:`

public uint Id { get; }

Effect id

Value Type

Type	Description
UInt32

`}),e.add({id:1147,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/id/",title:"Id",section:"ODIN Documentation",description:" RoomId ",content:`

public ulong Id { get; }

RoomId

Value Type

Type	Description
UInt64

`}),e.add({id:1148,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcresult/id/",title:"Id",section:"ODIN Documentation",description:" msgid ",content:`

public uint Id { get; }

msgid

Value Type

Type	Description
UInt32

`}),e.add({id:1149,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/mediarpc/id/",title:"Id",section:"ODIN Documentation",description:" media id ",content:`

public ushort Id

media id

Value Type

Type	Description
UInt16

`}),e.add({id:1150,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/peerrpc/id/",title:"Id",section:"ODIN Documentation",description:" peer id ",content:`

public ulong Id

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1151,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/id/",title:"Id",section:"ODIN Documentation",description:" Handle ID ",content:`

public long Id { get; }

Handle ID

Value Type

Type	Description
Int64

`}),e.add({id:1152,href:"https://www.4players.io/odin/sdk/unity/classes/peer/id/",title:"Id",section:"ODIN Documentation",description:" Peer id ",content:`

public ulong Id { get; }

Peer id

Value Type

Type	Description
UInt64

`}),e.add({id:1153,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imedia/",title:"IMedia",section:"ODIN Documentation",description:"",content:`

public interface IMedia

Public Methods

Name	Description
GetPipeline	Get native effect pipeline

`}),e.add({id:1154,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/",title:"IMsgPackWriter",section:"ODIN Documentation",description:" General Msgpack interface that will be used for sending RPC to the server. ",content:`

public interface IMsgPackWriter : IDisposable

General Msgpack interface that will be used for sending RPC to the server.

Public Methods

Name	Description
Append
GetBuffer
Clear
GetBytes
GetLength
Write
WriteArrayHeader
WriteBinary
WriteBool
WriteByte
WriteDouble
WriteFloat
WriteInt
WriteLong
WriteMapHeader
WriteSByte
WriteShort
WriteString
WriteUInt
WriteULong
WriteUShort

`}),e.add({id:1155,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/index_property/",title:"Index",section:"ODIN Documentation",description:" Effect index ",content:`

public uint Index { get; set; }

Effect index

Value Type

Type	Description
UInt32

`}),e.add({id:1156,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1157,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1158,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1159,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1160,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1161,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/initialize/",title:"Initialize",section:"ODIN Documentation",description:"",content:`

public static void Initialize()
public static void Initialize(OdinLibraryParameters parameters)

Initializes the native ODIN runtime

Info

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

Variants

Initialize()

public static void Initialize()

Initializes the native ODIN runtime

Warning

This function explicitly loads the ODIN library. It will be invoked automatically by the SDK when required.

Initialize(parameters)

public static void Initialize(OdinLibraryParameters parameters)

Creates a new Core-Instance

Parameters

Name	Type	Description
parameters	OdinLibraryParameters	Information used to create the instance

`}),e.add({id:1162,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/initroom/",title:"initRoom",section:"ODIN Documentation",description:"Authenticates against the ODIN server and returns an `OdinRoom` instance for the first room set in the specified token. This function accepts an optional `AudioContext` parameter for audio capture. The `AudioContext` interface is a part of the Web Audio API that represents an audio-processing graph, which can be used to control and manipulate audio signals in web applications. If the `AudioContext` is not provided or explicitly set to `undefined`, we will try to create one internally.",content:`

initRoom(token: string, gateway?: string, audioContext?: AudioContext): Promise<OdinRoom>

Authenticates against the ODIN server and returns an OdinRoom instance for the first room set in the specified token.

This function accepts an optional AudioContext parameter for audio capture. The AudioContext interface is a part of the Web Audio API that represents an audio-processing graph, which can be used to control and manipulate audio signals in web applications. If the AudioContext is not provided or explicitly set to undefined, we will try to create one internally.

Parameters

Name	Type	Description
token	string	The room token for authentication
gateway	string	The gateway to authenticate against
audioContext	AudioContext	An optional audio context to use for capture

Returns

Type	Description
Promise<OdinRoom>

`}),e.add({id:1163,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/initrooms/",title:"initRooms",section:"ODIN Documentation",description:"Authenticates against the ODIN server and returns `OdinRoom` instances for all rooms set in the specified token. This function accepts an optional `AudioContext` parameter for audio capture. The `AudioContext` interface is a part of the Web Audio API that represents an audio-processing graph, which can be used to control and manipulate audio signals in web applications. If the `AudioContext` is not provided or explicitly set to `undefined`, we will try to create one internally.",content:`

initRooms(token: string, gateway?: string, audioContext?: AudioContext): Promise<OdinRoom[]>

Authenticates against the ODIN server and returns OdinRoom instances for all rooms set in the specified token.

Parameters

Name	Type	Description
token	string	The room token for authentication
gateway	string	The gateway to authenticate against
audioContext	AudioContext	An optional audio context to use for capture

Returns

Type	Description
Promise<OdinRoom[]>

`}),e.add({id:1164,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/inputclip/",title:"InputClip",section:"ODIN Documentation",description:"",content:`

public AudioClip InputClip

Value Type

Type	Description
AudioClip

`}),e.add({id:1165,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string InputDevice

Value Type

Type	Description
String

`}),e.add({id:1166,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:" The device name to use as microphone in Unity. (i.e Microphone.Start) ",content:`

public string InputDevice

The device name to use as microphone in Unity. (i.e Microphone.Start)

Info

If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property. (see Microphone.devices)

Value Type

Type	Description
String

`}),e.add({id:1167,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:" The device name to use as microphone in Unity. (i.e Microphone.Start) ",content:`

public string InputDevice

The device name to use as microphone in Unity. (i.e Microphone.Start)

Info

If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property. (see Microphone.devices)

Value Type

Type	Description
String

`}),e.add({id:1168,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:" The device name to use as microphone in Unity. (i.e Microphone.Start) ",content:`

public string InputDevice

The device name to use as microphone in Unity. (i.e Microphone.Start)

Info

If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property. (see Microphone.devices)

Value Type

Type	Description
String

`}),e.add({id:1169,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:" The device name to use as microphone in Unity. (i.e Microphone.Start) ",content:`

public string InputDevice

The device name to use as microphone in Unity. (i.e Microphone.Start)

Info

If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property. (see Microphone.devices)

Value Type

Type	Description
String

`}),e.add({id:1170,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/inputdevice/",title:"InputDevice",section:"ODIN Documentation",description:" The device name to use as microphone in Unity. (i.e Microphone.Start) ",content:`

public string InputDevice

The device name to use as microphone in Unity. (i.e Microphone.Start)

Info

If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property. (see Microphone.devices)

Value Type

Type	Description
String

`}),e.add({id:1171,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/inputvolumescale/",title:"InputVolumeScale",section:"ODIN Documentation",description:"",content:`

public float InputVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1172,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/insertapmeffect/",title:"InsertApmEffect",section:"ODIN Documentation",description:"",content:`

public ApmEffect InsertApmEffect(uint indexId, uint samplerate, bool stereo)

Insert a apm effect to native pipeline

Parameters

Name	Type	Description
indexId	UInt32	effect index
samplerate	UInt32	effect playback samplerate
stereo	Boolean	effect playback stereo

Returns

Type	Description
ApmEffect

`}),e.add({id:1173,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/insertcustomeffect/",title:"InsertCustomEffect",section:"ODIN Documentation",description:"",content:`

public CustomEffect<T> InsertCustomEffect<T>(uint indexId, Action<OdinCallbackAudioData, IntPtr> callback, IntPtr user_data)
    where T : struct

Insert a custom effect to native pipeline

Parameters

Name	Type	Description
indexId	UInt32	effect index
callback	Action<OdinCallbackAudioData,IntPtr>	effect callback
user_data	IntPtr	effect callback userdata

Returns

Type	Description
CustomEffect<<T>>

`}),e.add({id:1174,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/insertvadeffect/",title:"InsertVadEffect",section:"ODIN Documentation",description:"",content:`

public VadEffect InsertVadEffect(uint indexId)

Insert a vad effect to native pipeline

Parameters

Name	Type	Description
indexId	UInt32	effect index

Returns

Type	Description
VadEffect

`}),e.add({id:1175,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/instance/",title:"Instance",section:"ODIN Documentation",description:" Singleton reference to this ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static OdinHandler Instance { get; }

Singleton reference to this OdinHandler

Info

Provides access to the client with a usual Unity singleton pattern and add a instance if the client is missing in the scene

Value Type

Type	Description
OdinHandler

`}),e.add({id:1176,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/instance/",title:"Instance",section:"ODIN Documentation",description:" Singleton reference to this ",content:`

public static OdinHandler Instance { get; }

Singleton reference to this OdinHandler

Info

Provides access to the client with a usual Unity singleton pattern and add a instance if the client is missing in the scene

Value Type

Type	Description
OdinHandler

`}),e.add({id:1177,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/instance/",title:"Instance",section:"ODIN Documentation",description:" Singleton reference to this ",content:`

public static OdinHandler Instance { get; }

Singleton reference to this OdinHandler

Info

Provides access to the client with a usual Unity singleton pattern and add a instance if the client is missing in the scene

Value Type

Type	Description
OdinHandler

`}),e.add({id:1178,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/instance/",title:"Instance",section:"ODIN Documentation",description:" Singleton reference to this ",content:`

public static OdinHandler Instance { get; }

Singleton reference to this OdinHandler

Info

Provides access to the client with a usual Unity singleton pattern and add a instance if the client is missing in the scene

Value Type

Type	Description
OdinHandler

`}),e.add({id:1179,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/instance/",title:"Instance",section:"ODIN Documentation",description:" Singleton reference to this ",content:`

public static OdinHandler Instance { get; }

Singleton reference to this OdinHandler

Info

Provides access to the client with a usual Unity singleton pattern and add a instance if the client is missing in the scene

Value Type

Type	Description
OdinHandler

`}),e.add({id:1180,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/int16/",title:"Int16",section:"ODIN Documentation",description:"",content:`

public const byte Int16 = 209

Value Type

Type	Description
Byte

`}),e.add({id:1181,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/int32/",title:"Int32",section:"ODIN Documentation",description:"",content:`

public const byte Int32 = 210

Value Type

Type	Description
Byte

`}),e.add({id:1182,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/int64/",title:"Int64",section:"ODIN Documentation",description:"",content:`

public const byte Int64 = 211

Value Type

Type	Description
Byte

`}),e.add({id:1183,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/int8/",title:"Int8",section:"ODIN Documentation",description:"",content:`

public const byte Int8 = 208

Value Type

Type	Description
Byte

`}),e.add({id:1184,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Interfaces:

OdinAPMSettings

OdinConnectionStateChangedEventPayload

OdinEventPayload

OdinEvents

OdinJoinedEventPayload

OdinLeftEventPayload

OdinMediaActivityEventPayload

OdinMediaAddedEventPayload

OdinMediaRemovedEventPayload

OdinMessageReceivedEventPayload

OdinPeerJoinedEventPayload

OdinPeerLeftEventPayload

OdinPeerUserDataChangedEventPayload

OdinRoomUserDataChangedEventPayload

`}),e.add({id:1185,href:"https://www.4players.io/odin/sdk/unity/1.1.0/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

The ODIN Unity SDK has defined these Interfaces:

`}),e.add({id:1186,href:"https://www.4players.io/odin/sdk/unity/1.5.8/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Interfaces:

`}),e.add({id:1187,href:"https://www.4players.io/odin/sdk/unity/1.6.0/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Interfaces:

`}),e.add({id:1188,href:"https://www.4players.io/odin/sdk/unity/1.6.6/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Interfaces:

`}),e.add({id:1189,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Interfaces:

IMedia

IMsgPackWriter

IOdinEffect

IPeer

IPiplineEffect

IRoom

`}),e.add({id:1190,href:"https://www.4players.io/odin/sdk/unity/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN Unity SDK has defined these Interfaces:

IOdinAudioStatsEventPayload

`}),e.add({id:1191,href:"https://www.4players.io/odin/sdk/web/interfaces/",title:"Interfaces",section:"ODIN Documentation",description:"An index of all Interfaces available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Interfaces:

IOdinAudioSettings

IOdinAudioStats

IOdinClientEvents

IOdinClientSettings

IOdinConnectionStateChangedEventPayload

IOdinEvent

IOdinMediaActivityChangedEventPayload

IOdinMediaEvents

IOdinMediaStartedStoppedEventPayload

IOdinMessageReceivedEventPayload

IOdinPeerDataChangedEventPayload

IOdinPeerEvents

IOdinPeerJoinedLeftEventPayload

IOdinRoomDataChangedEventPayload

IOdinRoomEvents

IOdinRoomJoinedLeftEventPayload

`}),e.add({id:1192,href:"https://www.4players.io/odin/sdk/unity/1.1.0/interfaces/iodinapmconfig/",title:"IOdinApmConfig",section:"ODIN Documentation",description:" Interface for Audio processing configuration of an ODIN room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1193,href:"https://www.4players.io/odin/sdk/unity/1.5.8/interfaces/iodinapmconfig/",title:"IOdinApmConfig",section:"ODIN Documentation",description:" Interface for Audio processing configuration of an ODIN room ",content:`

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1194,href:"https://www.4players.io/odin/sdk/unity/1.6.0/interfaces/iodinapmconfig/",title:"IOdinApmConfig",section:"ODIN Documentation",description:" Interface for Audio processing configuration of an ODIN room ",content:`

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1195,href:"https://www.4players.io/odin/sdk/unity/1.6.6/interfaces/iodinapmconfig/",title:"IOdinApmConfig",section:"ODIN Documentation",description:" Interface for Audio processing configuration of an ODIN room ",content:`

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1196,href:"https://www.4players.io/odin/sdk/unity/interfaces/iodinapmconfig/",title:"IOdinApmConfig",section:"ODIN Documentation",description:" Interface for Audio processing configuration of an ODIN room ",content:`

public interface IOdinApmConfig

Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1197,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/",title:"IOdinAudioSettings",section:"ODIN Documentation",description:"Interface describing audio settings to be applied on connect.",content:`

export interface IOdinAudioSettings

Interface describing audio settings to be applied on connect.

Properties

Name	Type	Description
voiceActivityDetection	boolean	Enable or disable RNN-based voice activity detection.
voiceActivityDetectionAttackProbability	number	Voice probability value when the VAD should engage
voiceActivityDetectionReleaseProbability	number	Voice probability value when the VAD should disengage
volumeGate	boolean	Enables or disables the input volume gate
volumeGateAttackLoudness	number	Root mean square power (dBFS) when the volume gate should engage
volumeGateReleaseLoudness	number	Root mean square power (dBFS) when the volume gate should disengage

`}),e.add({id:1198,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiostats/",title:"IOdinAudioStats",section:"ODIN Documentation",description:"Interface describing encoder/decoder statistics from the audio worker.",content:`

export interface IOdinAudioStats

Interface describing encoder/decoder statistics from the audio worker.

Properties

Name	Type	Description
decoder	{avg_decode_time: number, cache_length: number, packets_invalid: number, packets_lost: number, packets_processed: number, packets_repeated: number, packets_seen: number, packets_too_early: number, packets_too_late: number, rewinds: number}	Internal Opus decoder statistics.
encoder	{avg_encode_time: number, complexity: number, complexity_factor: number, fec: boolean, fec_packet_loss: number, voip: boolean}	Internal Opus encoder statistics.

`}),e.add({id:1199,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiostatseventpayload/",title:"IOdinAudioStatsEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinAudioStatsEvent`.",content:`

export interface IOdinAudioStatsEventPayload

Interface describing the payload of an OdinAudioStatsEvent.

Properties

Name	Type	Description
room	OdinRoom	The `OdinRoom` instance the stats ere coming from.
stats	IOdinAudioStats	The internal Opus encoder/decoder stats.

`}),e.add({id:1200,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinclientevents/",title:"IOdinClientEvents",section:"ODIN Documentation",description:"Interface describing possible media events.",content:`

export interface IOdinClientEvents

Interface describing possible media events.

Properties

Name	Type	Description
ConnectionStateChanged	OdinConnectionStateChangedEvent	Main stream connection state updates.

`}),e.add({id:1201,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinclientsettings/",title:"IOdinClientSettings",section:"ODIN Documentation",description:"Interface describing custom options for ODIN clients.",content:`

export interface IOdinClientSettings

Interface describing custom options for ODIN clients.

Properties

Name	Type	Description
gatewayUrl	string	The URL of the ODIN gateway to use.

`}),e.add({id:1202,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinconnectionstatechangedeventpayload/",title:"IOdinConnectionStateChangedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinConnectionStateChangedEvent`.",content:`

export interface IOdinConnectionStateChangedEventPayload

Interface describing the payload of an OdinConnectionStateChangedEvent.

Properties

Name	Type	Description
newState	OdinConnectionState	Current state of the connection.
oldState	OdinConnectionState	Previous state of the connection.

`}),e.add({id:1203,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iodineffect/",title:"IOdinEffect",section:"ODIN Documentation",description:"",content:`

public interface IOdinEffect

Public Methods

Name	Description
GetMedia
GetEffect

`}),e.add({id:1204,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinevent/",title:"IOdinEvent",section:"ODIN Documentation",description:"Interface extending default JavaScript events with custom information.",content:`

export interface IOdinEvent

Interface extending default JavaScript events with custom information.

Properties

Name	Type	Description
payload	T	Custom payload of the event (see `IOdin*Payload` interfaces).

`}),e.add({id:1205,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediaactivitychangedeventpayload/",title:"IOdinMediaActivityChangedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinMediaActivityChangedEvent`.",content:`

export interface IOdinMediaActivityChangedEventPayload

Interface describing the payload of an OdinMediaActivityChangedEvent.

Properties

Name	Type	Description
media	OdinMedia	The media that was updated.
peer	OdinPeer	The peer that owns the media.
room	OdinRoom	The room the media is added to.

`}),e.add({id:1206,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediaevents/",title:"IOdinMediaEvents",section:"ODIN Documentation",description:"Interface describing possible media events.",content:`

export interface IOdinMediaEvents

Interface describing possible media events.

Properties

Name	Type	Description
Activity	OdinMediaActivityChangedEvent	The media is sending/receiving data.

`}),e.add({id:1207,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediastartedstoppedeventpayload/",title:"IOdinMediaStartedStoppedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinMediaStartedStoppedEvent`.",content:`

export interface IOdinMediaStartedStoppedEventPayload

Interface describing the payload of an OdinMediaStartedStoppedEvent.

Properties

Name	Type	Description
media	OdinMedia	The media that was added/removed.
peer	OdinPeer	The peer that owns the media.
room	OdinRoom	The room where the media was added/removed.

`}),e.add({id:1208,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmessagereceivedeventpayload/",title:"IOdinMessageReceivedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinMessageReceivedEvent`.",content:`

export interface IOdinMessageReceivedEventPayload

Interface describing the payload of an OdinMessageReceivedEvent.

Properties

Name	Type	Description
message	Uint8Array	A byte array with the message.
room	OdinRoom	The room where the message was received.
senderId	number	The ID of the peer that sent the message (might not be in proximity).

`}),e.add({id:1209,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinpeerdatachangedeventpayload/",title:"IOdinPeerDataChangedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinPeerDataChangedEvent`.",content:`

export interface IOdinPeerDataChangedEventPayload

Interface describing the payload of an OdinPeerDataChangedEvent.

Properties

Name	Type	Description
peer	OdinPeer	The updated `OdinPeer` instance.
room	OdinRoom	The room where the peer was updated.

`}),e.add({id:1210,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinpeerevents/",title:"IOdinPeerEvents",section:"ODIN Documentation",description:"Interface describing possible peer events.",content:`

export interface IOdinPeerEvents

Interface describing possible peer events.

Properties

Name	Type	Description
MediaActivity	OdinMediaActivityChangedEvent	A media owned by the peer is sending/receiving data.
MediaStarted	OdinMediaStartedStoppedEvent	Peer added a new media stream.
MediaStopped	OdinMediaStartedStoppedEvent	Peer removed a media stream.
MessageReceived	OdinMessageReceivedEvent	Peer sent a message with arbitrary data.
UserDataChanged	OdinPeerDataChangedEvent	Peer updated its user data.

`}),e.add({id:1211,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinpeerjoinedlefteventpayload/",title:"IOdinPeerJoinedLeftEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinPeerJoinedLeftEvent`.",content:`

export interface IOdinPeerJoinedLeftEventPayload

Interface describing the payload of an OdinPeerJoinedLeftEvent.

Properties

Name	Type	Description
peer	OdinPeer	The peer that joined/left.
room	OdinRoom	The room the peer joined/left.

`}),e.add({id:1212,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinroomdatachangedeventpayload/",title:"IOdinRoomDataChangedEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinRoomDataChangedEvent`.",content:`

export interface IOdinRoomDataChangedEventPayload

Interface describing the payload of an OdinRoomDataChangedEvent.

Properties

Name	Type	Description
room	OdinRoom	The updated `OdinRoom` instance.

`}),e.add({id:1213,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinroomevents/",title:"IOdinRoomEvents",section:"ODIN Documentation",description:"Interface describing possible room events.",content:`

export interface IOdinRoomEvents

Interface describing possible room events.

Properties

Name	Type	Description
AudioStats	OdinAudioStatsEvent	Internal encoder/decoder stats updates.
ConnectionStateChanged	OdinConnectionStateChangedEvent	Room stream connection state updates.
Joined	OdinRoomJoinedLeftEvent	The room was joined successfully.
Left	OdinRoomJoinedLeftEvent	The room was left.
MediaActivity	OdinMediaActivityChangedEvent	A media in the room is sending/receiving data.
MediaStarted	OdinMediaStartedStoppedEvent	A new media stream was added to the room.
MediaStopped	OdinMediaStartedStoppedEvent	A media stream was removed from the room.
MessageReceived	OdinMessageReceivedEvent	Received a message with arbitrary data.
PeerJoined	OdinPeerJoinedLeftEvent	A new peer entered the room.
PeerLeft	OdinPeerJoinedLeftEvent	A peer left the room.
PeerUserDataChanged	OdinPeerDataChangedEvent	A peer in the room updated its user data.
UserDataChanged	OdinRoomDataChangedEvent	The global room user data was updated.
VoiceProcessingStats	OdinVoiceProcessingStatsEvent	Internal RNN VAD stats updates.

`}),e.add({id:1214,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinroomjoinedlefteventpayload/",title:"IOdinRoomJoinedLeftEventPayload",section:"ODIN Documentation",description:"Interface describing the payload of an `OdinRoomJoinedLeftEvent`.",content:`

export interface IOdinRoomJoinedLeftEventPayload

Interface describing the payload of an OdinRoomJoinedLeftEvent.

Properties

Name	Type	Description
room	OdinRoom	The room that was joined/left.

`}),e.add({id:1215,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/ios/",title:"iOS",section:"ODIN Documentation",description:"",content:`

iOS = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1216,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/ios/",title:"iOS",section:"ODIN Documentation",description:"",content:`

iOS = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1217,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/ios/",title:"iOS",section:"ODIN Documentation",description:"",content:`

iOS = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1218,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/ios/",title:"iOS",section:"ODIN Documentation",description:"",content:`

iOS = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1219,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipeer/",title:"IPeer",section:"ODIN Documentation",description:"",content:`

public interface IPeer

Public Methods

Name	Description
GetBasePeer	Get the underlying Odin
GetRoomApi	Get the underlying Room

`}),e.add({id:1220,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/",title:"IPiplineEffect",section:"ODIN Documentation",description:"",content:`

public interface IPiplineEffect

Public Methods

Name	Description
GetEffectIndex	Get native effect index
GetEffectType	Get native effect NativeBindings
GetVadConfig	Get native voice activity config
SetApmConfig	Set native audio processing config
SetApmStreamDelay	Set native audio processing delay
SetVadConfig	Set native voice activity config
UpdateApmPlayback	Send samples for native audio processing

`}),e.add({id:1221,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iroom/",title:"IRoom",section:"ODIN Documentation",description:"",content:`

public interface IRoom

Public Methods

Name	Description
GetBaseRoom	Get the underlying Room

`}),e.add({id:1222,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/is_end_of_spurt/",title:"is_end_of_spurt",section:"ODIN Documentation",description:"",content:`

public bool is_end_of_spurt

Value Type

Type	Description
Boolean

`}),e.add({id:1223,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/is_end_of_spurt/",title:"is_end_of_spurt",section:"ODIN Documentation",description:"",content:`

public bool is_end_of_spurt

Value Type

Type	Description
Boolean

`}),e.add({id:1224,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/is_silent/",title:"is_silent",section:"ODIN Documentation",description:"",content:`

public bool is_silent

Value Type

Type	Description
Boolean

`}),e.add({id:1225,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/is_silent/",title:"is_silent",section:"ODIN Documentation",description:"",content:`

public bool is_silent

Value Type

Type	Description
Boolean

`}),e.add({id:1226,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinaudioreadonlydata/is_silent/",title:"is_silent",section:"ODIN Documentation",description:"",content:`

public bool is_silent

Value Type

Type	Description
Boolean

`}),e.add({id:1227,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/isactive/",title:"IsActive",section:"ODIN Documentation",description:" Indicates wether or not the media stream is active and sending/receiving data ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsActive { get; }

Indicates wether or not the media stream is active and sending/receiving data

Value Type

Type	Description
Boolean

`}),e.add({id:1228,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/isactive/",title:"IsActive",section:"ODIN Documentation",description:" Indicates wether or not the media stream is active and sending/receiving data ",content:`

public bool IsActive { get; }

Indicates wether or not the media stream is active and sending/receiving data

Value Type

Type	Description
Boolean

`}),e.add({id:1229,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/isactive/",title:"IsActive",section:"ODIN Documentation",description:" Indicates wether or not the media stream is active and sending/receiving data ",content:`

public bool IsActive { get; }

Indicates wether or not the media stream is active and sending/receiving data

Value Type

Type	Description
Boolean

`}),e.add({id:1230,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/isactive/",title:"IsActive",section:"ODIN Documentation",description:" Indicates wether or not the media stream is active and sending/receiving data ",content:`

public bool IsActive { get; }

Indicates wether or not the media stream is active and sending/receiving data

Value Type

Type	Description
Boolean

`}),e.add({id:1231,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/isactive/",title:"IsActive",section:"ODIN Documentation",description:" Indicates wether or not the media stream is active and sending/receiving data ",content:`

public bool IsActive { get; }

Indicates wether or not the media stream is active and sending/receiving data

Value Type

Type	Description
Boolean

`}),e.add({id:1232,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnectionpoolhandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1233,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindecoderhandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1234,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinencoderhandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1235,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpipelinehandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1236,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroomhandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1237,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odintokengeneratorhandle/isalive/",title:"IsAlive",section:"ODIN Documentation",description:"",content:`

public bool IsAlive { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1238,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isarray/",title:"IsArray",section:"ODIN Documentation",description:"",content:`

public static bool IsArray(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1239,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isbinary/",title:"IsBinary",section:"ODIN Documentation",description:"",content:`

public static bool IsBinary(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1240,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isbyte/",title:"IsByte",section:"ODIN Documentation",description:"",content:`

public static bool IsByte(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1241,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/isclosed/",title:"IsClosed",section:"ODIN Documentation",description:" IsClosed ",content:`

public bool IsClosed { get; }

IsClosed

Value Type

Type	Description
Boolean

`}),e.add({id:1242,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/isconnected/",title:"IsConnected",section:"ODIN Documentation",description:" IsJoined ",content:`

public bool IsConnected { get; }

IsJoined

Value Type

Type	Description
Boolean

`}),e.add({id:1243,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/iscreated/",title:"IsCreated",section:"ODIN Documentation",description:"",content:`

public bool IsCreated { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1244,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/iscreated/",title:"IsCreated",section:"ODIN Documentation",description:" Flag if the effect was added to the pipeline ",content:`

public bool IsCreated { get; }

Flag if the effect was added to the pipeline

Value Type

Type	Description
Boolean

`}),e.add({id:1245,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/iscreated/",title:"IsCreated",section:"ODIN Documentation",description:"",content:`

public bool IsCreated { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1246,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isdouble/",title:"IsDouble",section:"ODIN Documentation",description:"",content:`

public static bool IsDouble(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1247,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1248,href:"https://www.4players.io/odin/sdk/unity/1.1.0/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1249,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1250,href:"https://www.4players.io/odin/sdk/unity/1.5.8/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1251,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1252,href:"https://www.4players.io/odin/sdk/unity/1.6.0/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1253,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1254,href:"https://www.4players.io/odin/sdk/unity/1.6.6/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1255,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1256,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1257,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

public virtual bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1258,href:"https://www.4players.io/odin/sdk/unity/interfaces/iuserdata/isempty/",title:"IsEmpty",section:"ODIN Documentation",description:"",content:`

bool IsEmpty()

Indicates whether data is null or empty

Returns

Type	Description
Boolean	true if empty

`}),e.add({id:1259,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/isenabled/",title:"IsEnabled",section:"ODIN Documentation",description:" Flag if the component is active or use isActiveAndEnabled ",content:`

public bool IsEnabled { get; }

Flag if the component is active or use isActiveAndEnabled

Value Type

Type	Description
Boolean

`}),e.add({id:1260,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/utility/iserror/",title:"IsError",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool IsError(uint error)

Determines if the specified error code identifies an actual error.

Parameters

Name	Type	Description
error	UInt32	error code

Returns

Type	Description
Boolean	true if error

`}),e.add({id:1261,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/utility/iserror/",title:"IsError",section:"ODIN Documentation",description:"",content:`

public static bool IsError(uint error)

Determines if the specified error code identifies an actual error.

Parameters

Name	Type	Description
error	UInt32	error code

Returns

Type	Description
Boolean	true if error

`}),e.add({id:1262,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/utility/iserror/",title:"IsError",section:"ODIN Documentation",description:"",content:`

public static bool IsError(uint error)

Determines if the specified error code identifies an actual error.

Parameters

Name	Type	Description
error	UInt32	error code

Returns

Type	Description
Boolean	true if error

`}),e.add({id:1263,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/utility/iserror/",title:"IsError",section:"ODIN Documentation",description:"",content:`

public static bool IsError(uint error)

Determines if the specified error code identifies an actual error.

Parameters

Name	Type	Description
error	UInt32	error code

Returns

Type	Description
Boolean	true if error

`}),e.add({id:1264,href:"https://www.4players.io/odin/sdk/unity/classes/utility/iserror/",title:"IsError",section:"ODIN Documentation",description:"",content:`

public static bool IsError(uint error)

Determines if the specified error code identifies an actual error.

Parameters

Name	Type	Description
error	UInt32	error code

Returns

Type	Description
Boolean	true if error

`}),e.add({id:1265,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isextension/",title:"IsExtension",section:"ODIN Documentation",description:"",content:`

public static bool IsExtension(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1266,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isfixarray/",title:"IsFixArray",section:"ODIN Documentation",description:"",content:`

public static bool IsFixArray(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1267,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isfixmap/",title:"IsFixMap",section:"ODIN Documentation",description:"",content:`

public static bool IsFixMap(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1268,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isfixstr/",title:"IsFixStr",section:"ODIN Documentation",description:"",content:`

public static bool IsFixStr(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1269,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isfloat/",title:"IsFloat",section:"ODIN Documentation",description:"",content:`

public static bool IsFloat(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1270,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1271,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1272,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1273,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1274,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1275,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/isinitialized/",title:"IsInitialized",section:"ODIN Documentation",description:" Indicates whether or not the native ODIN runtime has been loaded and initialized ",content:`

public static bool IsInitialized { get; }

Indicates whether or not the native ODIN runtime has been loaded and initialized

Value Type

Type	Description
Boolean

`}),e.add({id:1276,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isint/",title:"IsInt",section:"ODIN Documentation",description:"",content:`

public static bool IsInt(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1277,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/isinvalid/",title:"IsInvalid",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsInvalid { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1278,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/isinvalid/",title:"IsInvalid",section:"ODIN Documentation",description:" Indicates wether or not the media stream handle is invalid or closed ",content:`

public bool IsInvalid { get; }

Indicates wether or not the media stream handle is invalid or closed

Value Type

Type	Description
Boolean

`}),e.add({id:1279,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/isinvalid/",title:"IsInvalid",section:"ODIN Documentation",description:"",content:`

public bool IsInvalid { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1280,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/isinvalid/",title:"IsInvalid",section:"ODIN Documentation",description:" Indicates wether or not the media stream handle is invalid or closed ",content:`

public bool IsInvalid { get; }

Indicates wether or not the media stream handle is invalid or closed

Value Type

Type	Description
Boolean

`}),e.add({id:1281,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/isinvalid/",title:"IsInvalid",section:"ODIN Documentation",description:" Indicates wether or not the media stream handle is invalid or closed ",content:`

public bool IsInvalid { get; }

Indicates wether or not the media stream handle is invalid or closed

Value Type

Type	Description
Boolean

`}),e.add({id:1282,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/isjoined/",title:"IsJoined",section:"ODIN Documentation",description:" true on successful Join or false ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsJoined { get; }

true on successful Join or false

Value Type

Type	Description
Boolean

`}),e.add({id:1283,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/isjoined/",title:"IsJoined",section:"ODIN Documentation",description:" true on successful Join or false ",content:`

public bool IsJoined { get; }

true on successful Join or false

Value Type

Type	Description
Boolean

`}),e.add({id:1284,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/isjoined/",title:"IsJoined",section:"ODIN Documentation",description:" true on successful Join or false ",content:`

public bool IsJoined { get; }

true on successful Join or false

Value Type

Type	Description
Boolean

`}),e.add({id:1285,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/isjoined/",title:"IsJoined",section:"ODIN Documentation",description:" true on successful Join or false ",content:`

public bool IsJoined { get; }

true on successful Join or false

Value Type

Type	Description
Boolean

`}),e.add({id:1286,href:"https://www.4players.io/odin/sdk/unity/classes/room/isjoined/",title:"IsJoined",section:"ODIN Documentation",description:" true on successful Join or false ",content:`

public bool IsJoined { get; }

true on successful Join or false

Value Type

Type	Description
Boolean

`}),e.add({id:1287,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/islong/",title:"IsLong",section:"ODIN Documentation",description:"",content:`

public static bool IsLong(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1288,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/ismap/",title:"IsMap",section:"ODIN Documentation",description:"",content:`

public static bool IsMap(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1289,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/ismuted/",title:"IsMuted",section:"ODIN Documentation",description:" Indicates wether or not the media stream is muted ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsMuted { get; set; }

Indicates wether or not the media stream is muted

Info

If true, no data will always be empty and thrown away

Value Type

Type	Description
Boolean

`}),e.add({id:1290,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/ismuted/",title:"IsMuted",section:"ODIN Documentation",description:" Indicates wether or not the media stream is muted ",content:`

public bool IsMuted { get; set; }

Indicates wether or not the media stream is muted

Info

If true, no data will always be empty and thrown away

Value Type

Type	Description
Boolean

`}),e.add({id:1291,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/ismuted/",title:"IsMuted",section:"ODIN Documentation",description:"",content:`

public bool IsMuted { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1292,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/ismuted/",title:"IsMuted",section:"ODIN Documentation",description:" Indicates wether or not the media stream is muted ",content:`

public bool IsMuted { get; set; }

Indicates wether or not the media stream is muted

Info

If true, no data will always be empty and thrown away

Value Type

Type	Description
Boolean

`}),e.add({id:1293,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/ismuted/",title:"IsMuted",section:"ODIN Documentation",description:"",content:`

public bool IsMuted { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1294,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isnegativefixint/",title:"IsNegativeFixInt",section:"ODIN Documentation",description:"",content:`

public static bool IsNegativeFixInt(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1295,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isnil/",title:"IsNil",section:"ODIN Documentation",description:"",content:`

public static bool IsNil(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1296,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/isok/",title:"IsOk",section:"ODIN Documentation",description:"",content:`

public static bool IsOk(NativeBindings.OdinError error)

Checks the return code for errors

Parameters

Name	Type	Description
error	OdinError	Odin error return code

Returns

Type	Description
Boolean	false on error

`}),e.add({id:1297,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/ispaused/",title:"IsPaused",section:"ODIN Documentation",description:" Indicates wether or not the media stream is paused ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsPaused { get; set; }

Indicates wether or not the media stream is paused

Info

If true, no data will be read/pushed for the media handle

Value Type

Type	Description
Boolean

`}),e.add({id:1298,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/ispaused/",title:"IsPaused",section:"ODIN Documentation",description:" Indicates wether or not the media stream is paused ",content:`

public bool IsPaused { get; set; }

Indicates wether or not the media stream is paused

Info

If true, no data will be read/pushed for the media handle

Value Type

Type	Description
Boolean

`}),e.add({id:1299,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/ispaused/",title:"IsPaused",section:"ODIN Documentation",description:"",content:`

public bool IsPaused { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1300,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/ispaused/",title:"IsPaused",section:"ODIN Documentation",description:" Indicates wether or not the media stream is paused ",content:`

public bool IsPaused { get; set; }

Indicates wether or not the media stream is paused

Info

If true, no data will be read/pushed for the media handle

Value Type

Type	Description
Boolean

`}),e.add({id:1301,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/ispositivefixint/",title:"IsPositiveFixInt",section:"ODIN Documentation",description:"",content:`

public static bool IsPositiveFixInt(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1302,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1303,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1304,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1305,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1306,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1307,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1308,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1309,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1310,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1311,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/isreadonly/",title:"IsReadOnly",section:"ODIN Documentation",description:" Indicates whether elements can be added or removed from the collection ",content:`

public bool IsReadOnly { get; }

Indicates whether elements can be added or removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1312,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1313,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1314,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1315,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1316,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1317,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/isremoveonly/",title:"IsRemoveOnly",section:"ODIN Documentation",description:" Indicates whether elements can be removed from the collection ",content:`

public bool IsRemoveOnly { get; }

Indicates whether elements can be removed from the collection

Value Type

Type	Description
Boolean

`}),e.add({id:1318,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/issbyte/",title:"IsSByte",section:"ODIN Documentation",description:"",content:`

public static bool IsSByte(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1319,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isshort/",title:"IsShort",section:"ODIN Documentation",description:"",content:`

public static bool IsShort(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1320,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/issilent/",title:"IsSilent",section:"ODIN Documentation",description:"",content:`

public bool IsSilent { get; }

Value Type

Type	Description
Boolean

`}),e.add({id:1321,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/isstereo/",title:"IsStereo",section:"ODIN Documentation",description:" Output decoder channel flag ",content:`

public bool IsStereo { get; }

Output decoder channel flag

Value Type

Type	Description
Boolean

`}),e.add({id:1322,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/isstereo/",title:"IsStereo",section:"ODIN Documentation",description:" Unity channel flag ",content:`

public bool IsStereo { get; set; }

Unity channel flag

Info

We let Unity resample/mix audio on demand and use only mono by default internally

Value Type

Type	Description
Boolean

`}),e.add({id:1323,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isstring/",title:"IsString",section:"ODIN Documentation",description:"",content:`

public static bool IsString(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1324,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isuint/",title:"IsUInt",section:"ODIN Documentation",description:"",content:`

public static bool IsUInt(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1325,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isulong/",title:"IsULong",section:"ODIN Documentation",description:"",content:`

public static bool IsULong(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1326,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/isushort/",title:"IsUShort",section:"ODIN Documentation",description:"",content:`

public static bool IsUShort(byte token)

Parameters

Name	Type	Description
token	Byte

Returns

Type	Description
Boolean

`}),e.add({id:1327,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/this/",title:"Item[Int32]",section:"ODIN Documentation",description:"",content:`

public readonly MsgPackReader this[int index] { get; }

Value Type

Type	Description
MsgPackReader

`}),e.add({id:1328,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/this/",title:"Item[Int64]",section:"ODIN Documentation",description:" Try to get a media stream by ID ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaStream this[long key] { get; }

Try to get a media stream by ID

Value Type

Type	Description
MediaStream	MediaStream or null

`}),e.add({id:1329,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/this/",title:"Item[Int64]",section:"ODIN Documentation",description:" Try to get a media stream by ID ",content:`

public MediaStream this[long key] { get; }

Try to get a media stream by ID

Value Type

Type	Description
MediaStream	MediaStream or null

`}),e.add({id:1330,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/this/",title:"Item[Int64]",section:"ODIN Documentation",description:" Try to get a media stream by ID ",content:`

public MediaStream this[long key] { get; }

Try to get a media stream by ID

Value Type

Type	Description
MediaStream	MediaStream or null

`}),e.add({id:1331,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/this/",title:"Item[Int64]",section:"ODIN Documentation",description:" Try to get a media stream by ID ",content:`

public MediaStream this[long key] { get; }

Try to get a media stream by ID

Value Type

Type	Description
MediaStream	MediaStream or null

`}),e.add({id:1332,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/this/",title:"Item[Int64]",section:"ODIN Documentation",description:" Try to get a media stream by ID ",content:`

public MediaStream this[long key] { get; }

Try to get a media stream by ID

Value Type

Type	Description
MediaStream	MediaStream or null

`}),e.add({id:1333,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/this/",title:"Item[String]",section:"ODIN Documentation",description:" Try to get room by name ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Room this[string key] { get; }

Try to get room by name

Value Type

Type	Description
Room	Room or null

`}),e.add({id:1334,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/this/",title:"Item[String]",section:"ODIN Documentation",description:" Try to get room by name ",content:`

public Room this[string key] { get; }

Try to get room by name

Value Type

Type	Description
Room	Room or null

`}),e.add({id:1335,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/this/",title:"Item[String]",section:"ODIN Documentation",description:" Try to get room by name ",content:`

public Room this[string key] { get; }

Try to get room by name

Value Type

Type	Description
Room	Room or null

`}),e.add({id:1336,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/this/",title:"Item[String]",section:"ODIN Documentation",description:" Try to get room by name ",content:`

public Room this[string key] { get; }

Try to get room by name

Value Type

Type	Description
Room	Room or null

`}),e.add({id:1337,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/this/",title:"Item[String]",section:"ODIN Documentation",description:" Try to get room by name ",content:`

public Room this[string key] { get; }

Try to get room by name

Value Type

Type	Description
Room	Room or null

`}),e.add({id:1338,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Try to get Peer by id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer this[ulong key] { get; }

Try to get Peer by id

Value Type

Type	Description
Peer	Peer or null

`}),e.add({id:1339,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Try to get Peer by id ",content:`

public Peer this[ulong key] { get; }

Try to get Peer by id

Value Type

Type	Description
Peer	Peer or null

`}),e.add({id:1340,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Try to get Peer by id ",content:`

public Peer this[ulong key] { get; }

Try to get Peer by id

Value Type

Type	Description
Peer	Peer or null

`}),e.add({id:1341,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Try to get Peer by id ",content:`

public Peer this[ulong key] { get; }

Try to get Peer by id

Value Type

Type	Description
Peer	Peer or null

`}),e.add({id:1342,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Get room by Id ",content:`

public Room this[ulong id] { get; }

Get room by Id

Value Type

Type	Description
Room	Room

`}),e.add({id:1343,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/this/",title:"Item[UInt64]",section:"ODIN Documentation",description:" Try to get Peer by id ",content:`

public Peer this[ulong key] { get; }

Try to get Peer by id

Value Type

Type	Description
Peer	Peer or null

`}),e.add({id:1344,href:"https://www.4players.io/odin/sdk/unity/1.1.0/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1345,href:"https://www.4players.io/odin/sdk/unity/1.5.8/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1346,href:"https://www.4players.io/odin/sdk/unity/1.6.0/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1347,href:"https://www.4players.io/odin/sdk/unity/1.6.6/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1348,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1349,href:"https://www.4players.io/odin/sdk/unity/interfaces/iuserdata/",title:"IUserData",section:"ODIN Documentation",description:" interface for transmitting UserData ",content:`

public interface IUserData

interface for transmitting UserData

Public Methods

Name	Description
IsEmpty	Indicates whether data is null or empty
ToBytes	Used for converting Data on network level

`}),e.add({id:1350,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinaudiostreamstats/jitter_packets_dropped_too_early/",title:"jitter_packets_dropped_too_early",section:"ODIN Documentation",description:" The number of packets dropped because they seemed to arrive too early. ",content:`

public uint jitter_packets_dropped_too_early

The number of packets dropped because they seemed to arrive too early.

Value Type

Type	Description
UInt32

`}),e.add({id:1351,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinaudiostreamstats/jitter_packets_dropped_too_early/",title:"jitter_packets_dropped_too_early",section:"ODIN Documentation",description:" The number of packets dropped because they seemed to arrive too early. ",content:`

public uint jitter_packets_dropped_too_early

The number of packets dropped because they seemed to arrive too early.

Value Type

Type	Description
UInt32

`}),e.add({id:1352,href:"https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats/jitter_packets_dropped_too_early/",title:"jitter_packets_dropped_too_early",section:"ODIN Documentation",description:" The number of packets dropped because they seemed to arrive too early. ",content:`

public uint jitter_packets_dropped_too_early

The number of packets dropped because they seemed to arrive too early.

Value Type

Type	Description
UInt32

`}),e.add({id:1353,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinaudiostreamstats/jitter_packets_dropped_too_late/",title:"jitter_packets_dropped_too_late",section:"ODIN Documentation",description:" The number of packets processed because they seemed to arrive too late. ",content:`

public uint jitter_packets_dropped_too_late

The number of packets processed because they seemed to arrive too late.

Value Type

Type	Description
UInt32

`}),e.add({id:1354,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinaudiostreamstats/jitter_packets_dropped_too_late/",title:"jitter_packets_dropped_too_late",section:"ODIN Documentation",description:" The number of packets processed because they seemed to arrive too late. ",content:`

public uint jitter_packets_dropped_too_late

The number of packets processed because they seemed to arrive too late.

Value Type

Type	Description
UInt32

`}),e.add({id:1355,href:"https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats/jitter_packets_dropped_too_late/",title:"jitter_packets_dropped_too_late",section:"ODIN Documentation",description:" The number of packets processed because they seemed to arrive too late. ",content:`

public uint jitter_packets_dropped_too_late

The number of packets processed because they seemed to arrive too late.

Value Type

Type	Description
UInt32

`}),e.add({id:1356,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinaudiostreamstats/jitter_packets_lost/",title:"jitter_packets_lost",section:"ODIN Documentation",description:" The number of packets marked as lost during transmission. ",content:`

public uint jitter_packets_lost

The number of packets marked as lost during transmission.

Value Type

Type	Description
UInt32

`}),e.add({id:1357,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinaudiostreamstats/jitter_packets_lost/",title:"jitter_packets_lost",section:"ODIN Documentation",description:" The number of packets marked as lost during transmission. ",content:`

public uint jitter_packets_lost

The number of packets marked as lost during transmission.

Value Type

Type	Description
UInt32

`}),e.add({id:1358,href:"https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats/jitter_packets_lost/",title:"jitter_packets_lost",section:"ODIN Documentation",description:" The number of packets marked as lost during transmission. ",content:`

public uint jitter_packets_lost

The number of packets marked as lost during transmission.

Value Type

Type	Description
UInt32

`}),e.add({id:1359,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinaudiostreamstats/jitter_packets_processed/",title:"jitter_packets_processed",section:"ODIN Documentation",description:" The number of packets processed by the medias jitter buffer. ",content:`

public uint jitter_packets_processed

The number of packets processed by the medias jitter buffer.

Value Type

Type	Description
UInt32

`}),e.add({id:1360,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinaudiostreamstats/jitter_packets_processed/",title:"jitter_packets_processed",section:"ODIN Documentation",description:" The number of packets processed by the medias jitter buffer. ",content:`

public uint jitter_packets_processed

The number of packets processed by the medias jitter buffer.

Value Type

Type	Description
UInt32

`}),e.add({id:1361,href:"https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats/jitter_packets_processed/",title:"jitter_packets_processed",section:"ODIN Documentation",description:" The number of packets processed by the medias jitter buffer. ",content:`

public uint jitter_packets_processed

The number of packets processed by the medias jitter buffer.

Value Type

Type	Description
UInt32

`}),e.add({id:1362,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/join/",title:"join",section:"ODIN Documentation",description:"Joins the room with the given gateway URL and optional user data.",content:`

public join(gatewayOrServerUrl: string, userData?: Uint8Array): void

Joins the room with the given gateway URL and optional user data.

Parameters

Name	Type	Description
gatewayOrServerUrl	string
userData	Uint8Array	The user data to send to the room. This can be used to identify the user.

Returns

Type	Description
void

`}),e.add({id:1363,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/join/",title:"join",section:"ODIN Documentation",description:"Joins the room and returns your own peer instance after the room was successfully joined.",content:`

join(userData?: Uint8Array, position?: any): Promise<OdinPeer>

Joins the room and returns your own peer instance after the room was successfully joined.

Parameters

Name	Type	Description
userData	Uint8Array	Optional user data to set for the peer when connecting
position	any	Optional coordinates to set the three-dimensional position of the peer in the room when connecting

Returns

Type	Description
Promise<OdinPeer>

`}),e.add({id:1364,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Join(string name, string userId, IUserData userData = null)
public bool Join(string token)

Join the room via Odin gateway

Info

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

Variants

Join(name, userId, userData)

public bool Join(string name, string userId, IUserData userData = null)

Join the room via Odin gateway

Warning

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata

Returns

Type	Description
Boolean	true on successful join or false

Join(token)

public bool Join(string token)

Join the room via Odin gateway

Warning

The room token should be generated SERVER SIDE by String%40%2cSystem

Parameters

Name	Type	Description
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

`}),e.add({id:1365,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public bool Join(string name, string userId, IUserData userData = null)
public bool Join(string token)

Join the room via Odin gateway

Info

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

Variants

Join(name, userId, userData)

public bool Join(string name, string userId, IUserData userData = null)

Join the room via Odin gateway

Warning

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata

Returns

Type	Description
Boolean	true on successful join or false

Join(token)

public bool Join(string token)

Join the room via Odin gateway

Warning

The room token should be generated SERVER SIDE by String%40%2cSystem

Parameters

Name	Type	Description
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

`}),e.add({id:1366,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public bool Join(string name, string userId, IUserData userData = null)
public bool Join(string token)

Join the room via Odin gateway

Info

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

Variants

Join(name, userId, userData)

public bool Join(string name, string userId, IUserData userData = null)

Join the room via Odin gateway

Warning

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata

Returns

Type	Description
Boolean	true on successful join or false

Join(token)

public bool Join(string token)

Join the room via Odin gateway

Warning

The room token should be generated SERVER SIDE by String%40%2cSystem

Parameters

Name	Type	Description
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

`}),e.add({id:1367,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public bool Join(string name, string userId, IUserData userData = null)
public bool Join(string token)

Join the room via Odin gateway

Info

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

Variants

Join(name, userId, userData)

public bool Join(string name, string userId, IUserData userData = null)

Join the room via Odin gateway

Warning

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata

Returns

Type	Description
Boolean	true on successful join or false

Join(token)

public bool Join(string token)

Join the room via Odin gateway

Warning

The room token should be generated SERVER SIDE by String%40%2cSystem

Parameters

Name	Type	Description
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

`}),e.add({id:1368,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public bool Join(Room room, string token)
public bool Join(Room room, string token, string roomName, byte[] userData, float positionX, float positionY)

Join a object of base Room

Info

If the join fails the room is freed and removed from the client

Parameters

Name	Type	Description
room	Room	base type
token	String
roomName	String	room alias
userData	Byte[]	initial userdata
positionX	Single	server culling position X
positionY	Single	server culling position Y

Returns

Type	Description
Boolean

Variants

Join(room, token)

public bool Join(Room room, string token)

Join a object of base Room

Warning

If the join fails the room is freed and removed from the client

Parameters

Name	Type	Description
room	Room	base type
token	String

Returns

Type	Description
Boolean

Join(room, token, roomName, userData, positionX, positionY)

public bool Join(Room room, string token, string roomName, byte[] userData, float positionX, float positionY)

Join a object of base Room

Warning

If the join fails the room is freed and removed from the client

Parameters

Name	Type	Description
room	Room	base type
token	String	token
roomName	String	room alias
userData	Byte[]	initial userdata
positionX	Single	server culling position X
positionY	Single	server culling position Y

Returns

Type	Description
Boolean	room or null

`}),e.add({id:1369,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public static bool Join(string endPoint, string token, uint samplerate, bool stereo, out Room room)
public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, uint samplerate, bool stereo, out Room room)
public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, out Room room)
public static Room Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo)

Create and join a Room

Parameters

Name	Type	Description
endPoint	String	Gateway server
token	String	Join token
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag
room	Room	Initialized room
connectionPoolHandle	OdinConnectionPoolHandle	Connection pool for the room
roomName	String	initial room name
userData	Byte[]	initial userdata
positionX	Single	initial position
positionY	Single	initial position
positionZ	Single	initial position

Returns

Type	Description
Boolean	true on successfully request join or false
Room	true on successfully request join or false

Variants

Join(endPoint, token, samplerate, stereo, room)

public static bool Join(string endPoint, string token, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

Name	Type	Description
endPoint	String	Gateway server
token	String	Join token
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag
room	Room	Initialized room

Returns

Type	Description
Boolean	true on successfully request join or false

Join(connectionPoolHandle, endPoint, token, samplerate, stereo, room)

public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

Name	Type	Description
connectionPoolHandle	OdinConnectionPoolHandle	Connection pool for the room
endPoint	String	Gateway server
token	String	Join token
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag
room	Room	Initialized room

Returns

Type	Description
Boolean	true on successfully request join or false

Join(connectionPoolHandle, endPoint, token, roomName, userData, positionX, positionY, positionZ, samplerate, stereo, room)

public static bool Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, out Room room)

Create and join a Room

Parameters

Name	Type	Description
connectionPoolHandle	OdinConnectionPoolHandle	Connection pool for the room
endPoint	String	Gateway server
token	String	Join token
roomName	String	initial room name
userData	Byte[]	initial userdata
positionX	Single	initial position
positionY	Single	initial position
positionZ	Single	initial position
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag
room	Room	Initialized room

Returns

Type	Description
Boolean	true on successfully request join or false

Join(connectionPoolHandle, endPoint, token, roomName, userData, positionX, positionY, positionZ, samplerate, stereo)

public static Room Join(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo)

Create and join a Room

Parameters

Name	Type	Description
connectionPoolHandle	OdinConnectionPoolHandle	Connection pool for the room
endPoint	String	Gateway server
token	String	Join token
roomName	String	initial room name
userData	Byte[]	initial userdata
positionX	Single	initial position
positionY	Single	initial position
positionZ	Single	initial position
samplerate	UInt32	sets default samplerate
stereo	Boolean	sets default stereo flag

Returns

Type	Description
Room	true on successfully request join or false

`}),e.add({id:1370,href:"https://www.4players.io/odin/sdk/unity/classes/room/join/",title:"Join",section:"ODIN Documentation",description:"",content:`

public bool Join(string name, string userId, IUserData userData = null)
public bool Join(string token)

Join the room via Odin gateway

Info

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

Variants

Join(name, userId, userData)

public bool Join(string name, string userId, IUserData userData = null)

Join the room via Odin gateway

Warning

Generates a room token and update UserData before join

Parameters

Name	Type	Description
name	String	room name
userId	String	user id
userData	IUserData	custom userdata

Returns

Type	Description
Boolean	true on successful join or false

Join(token)

public bool Join(string token)

Join the room via Odin gateway

Warning

The room token should be generated SERVER SIDE by String%40%2cSystem

Parameters

Name	Type	Description
token	String	room token

Returns

Type	Description
Boolean	true on successful join or false

`}),e.add({id:1371,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/joined/",title:"Joined",section:"ODIN Documentation",description:"Fired when the local user connected to the room (successfully joined).",content:`

public Joined: OdinJoinedEvent

Fired when the local user connected to the room (successfully joined).

Parameters

Name	Type	Description
roomalias	String	Room alias
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1374,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/joinnamedroom/",title:"JoinNamedRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinNamedRoom(string roomalias, string token, IUserData userData = null, Action<Room> setup = null)

Join or create a named Room by token via a gateway

Parameters

Name	Type	Description
roomalias	String	Room alias
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1375,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/joinnamedroom/",title:"JoinNamedRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinNamedRoom(string roomalias, string token, IUserData userData = null, Action<Room> setup = null)

Join or create a named Room by token via a gateway

Parameters

Name	Type	Description
roomalias	String	Room alias
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1376,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/joinnamedroom/",title:"JoinNamedRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinNamedRoom(string roomalias, string token, IUserData userData = null, Action<Room> setup = null)

Join or create a named Room by token via a gateway

Parameters

Name	Type	Description
roomalias	String	Room alias
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1377,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/joinnamedroom/",title:"JoinNamedRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinNamedRoom(string roomalias, string token, IUserData userData = null, Action<Room> setup = null)

Join or create a named Room by token via a gateway

Parameters

Name	Type	Description
roomalias	String	Room alias
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1378,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<Room> JoinRoom(string name, string userId)
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID
setup	Action<Room>	will invoke to setup a room before adding or joining
userData	IUserData	Set new on room join
token	String	Room token

Returns

Type	Description
Task<Room>	or null

Variants

JoinRoom(name, userId)

public async Task<Room> JoinRoom(string name, string userId)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, setup)

public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, userData, setup)

public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(token, userData, setup)

public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by token via a gateway

Parameters

Name	Type	Description
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1379,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Info

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData

Variants

JoinRoom(roomName, userData, setup)

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

JoinRoom(roomAlias, token, userData, setup)

public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

`}),e.add({id:1380,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinRoom(string name, string userId)
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID
setup	Action<Room>	will invoke to setup a room before adding or joining
userData	IUserData	Set new on room join
token	String	Room token

Returns

Type	Description
Task<Room>	or null

Variants

JoinRoom(name, userId)

public async Task<Room> JoinRoom(string name, string userId)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, setup)

public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, userData, setup)

public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(token, userData, setup)

public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by token via a gateway

Parameters

Name	Type	Description
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1381,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Info

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData

Variants

JoinRoom(roomName, userData, setup)

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

JoinRoom(roomAlias, token, userData, setup)

public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

`}),e.add({id:1382,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinRoom(string name, string userId)
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID
setup	Action<Room>	will invoke to setup a room before adding or joining
userData	IUserData	Set new on room join
token	String	Room token

Returns

Type	Description
Task<Room>	or null

Variants

JoinRoom(name, userId)

public async Task<Room> JoinRoom(string name, string userId)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, setup)

public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, userData, setup)

public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(token, userData, setup)

public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by token via a gateway

Parameters

Name	Type	Description
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1383,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Info

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData

Variants

JoinRoom(roomName, userData, setup)

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

JoinRoom(roomAlias, token, userData, setup)

public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

`}),e.add({id:1384,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinRoom(string name, string userId)
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID
setup	Action<Room>	will invoke to setup a room before adding or joining
userData	IUserData	Set new on room join
token	String	Room token

Returns

Type	Description
Task<Room>	or null

Variants

JoinRoom(name, userId)

public async Task<Room> JoinRoom(string name, string userId)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, setup)

public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, userData, setup)

public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(token, userData, setup)

public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by token via a gateway

Parameters

Name	Type	Description
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1385,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Info

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData

Variants

JoinRoom(roomName, userData, setup)

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

JoinRoom(roomAlias, token, userData, setup)

public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

`}),e.add({id:1386,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public Room JoinRoom(string token, uint samplerate, bool stereo, bool handleRoom = true)
public Room JoinRoom(string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, bool handleRoom = true)

Create and join a Room

Parameters

Name	Type	Description
token	String	token
samplerate	UInt32
stereo	Boolean
handleRoom	Boolean	true will add the room to of the client
roomName	String	room alias
userData	Byte[]	initial userdata
positionX	Single	server culling position X
positionY	Single	server culling position Y
positionZ	Single

Returns

Type	Description
Room	room or null

Variants

JoinRoom(token, samplerate, stereo, handleRoom)

public Room JoinRoom(string token, uint samplerate, bool stereo, bool handleRoom = true)

Create and join a Room

Parameters

Name	Type	Description
token	String	token
samplerate	UInt32
stereo	Boolean
handleRoom	Boolean	true will add the room to of the client

Returns

Type	Description
Room	room or null

JoinRoom(token, roomName, userData, positionX, positionY, positionZ, samplerate, stereo, handleRoom)

public Room JoinRoom(string token, string roomName, byte[] userData, float positionX, float positionY, float positionZ, uint samplerate, bool stereo, bool handleRoom = true)

Create and join a Room

Parameters

Name	Type	Description
token	String	token
roomName	String	room alias
userData	Byte[]	initial userdata
positionX	Single	server culling position X
positionY	Single	server culling position Y
positionZ	Single
samplerate	UInt32
stereo	Boolean
handleRoom	Boolean	true will add the room to of the client

Returns

Type	Description
Room	room or null

`}),e.add({id:1387,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async Task<Room> JoinRoom(string name, string userId)
public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)
public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)
public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID
setup	Action<Room>	will invoke to setup a room before adding or joining
userData	IUserData	Set new on room join
token	String	Room token

Returns

Type	Description
Task<Room>	or null

Variants

JoinRoom(name, userId)

public async Task<Room> JoinRoom(string name, string userId)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	User ID

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, setup)

public async Task<Room> JoinRoom(string name, string userId, Action<Room> setup = null)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(name, userId, userData, setup)

public async Task<Room> JoinRoom(string name, string userId, IUserData userData, Action<Room> setup)

Join or create a Room by name via a gateway

Parameters

Name	Type	Description
name	String	Room name
userId	String	Odin client ID
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

JoinRoom(token, userData, setup)

public async Task<Room> JoinRoom(string token, IUserData userData, Action<Room> setup)

Join or create a Room by token via a gateway

Parameters

Name	Type	Description
token	String	Room token
userData	IUserData	Set new on room join
setup	Action<Room>	will invoke to setup a room before adding or joining

Returns

Type	Description
Task<Room>	or null

`}),e.add({id:1388,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/joinroom/",title:"JoinRoom",section:"ODIN Documentation",description:"",content:`

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)
public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Info

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData

Discussion

ODIN does not require any bookkeeping from your side. ODIN automatically creates a room when a user joins it (by name) and deletes the room once the last user has left the room.

Provide a room name as a string in roomName. It can be anything you like. Remember, that all users that have joined the same room can talk to each other (or at least listen to what others are saying). If you have two teams of users in your game, and each team should only talk to other team members, you could have two rooms: Team_A and Team_B. We have created a couple of use-cases explaining various methods of defining room names in this document.

userData is of type UserData and is basically just a byte array. You can set any user data you like. The best way is to create a class and serialize that class to whatever you like. We provide a sample of such a class in the guide Understanding User Data.

Use the setup callback to adjust room settings before data is sent to ODIN and the room is created on the ODIN servers.

public class Radio: MonoBehaviour
{
    private string _currentRoom;
    public int currentChannel = 1;
    
    void Start()
    {
        UpdateRadioConnection();
    }
    
    public void ChangeChannel(newChannel) 
    {
        currentChannel = newChannel;
        UpdateRadioConnection();
    }
    
    void UpdateRadioConnection()
    {
        // Leave the current radio room
        if (_currentRoom) {
            OdinHandler.Instance.LeaveRoom(_currentRoom);
        }
        
        _currentRoom = "Radio_" + currentChannel.ToString();
        OdinHandler.Instance.JoinRoom(_currentRoom, null, room => {
            // Activate Voice Activity Detection 
            room.Config.ApmConfig.VadEnable = true;
        });
    }
}

Variants

JoinRoom(roomName, userData, setup)

public async void JoinRoom(string roomName, IUserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomName	String	Room name
userData	IUserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

JoinRoom(roomAlias, token, userData, setup)

public async void JoinRoom(string roomAlias, string token, UserData userData = null, Action<Room> setup = null)

Join or create a room by name and attach a Media

Warning

Configure Room-Apm i.e VadEnable, … or Odin-Event-Listeners i.e PeerJoinedEvent, … with Config

Parameters

Name	Type	Description
roomAlias	String	Room name
token	String
userData	UserData	Override OdinClient default UserData
setup	Action<Room>	Override default Room setup

`}),e.add({id:1389,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/keytobytes/",title:"KeyToBytes",section:"ODIN Documentation",description:"",content:`

public static byte[] KeyToBytes(string key)

Parameters

Name	Type	Description
key	String

Returns

Type	Description
Byte[]

`}),e.add({id:1390,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediarpcproperties/kind/",title:"Kind",section:"ODIN Documentation",description:" preset field "Audio" ",content:`

public string Kind

preset field "Audio"

Value Type

Type	Description
String

`}),e.add({id:1391,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumecomponent/ldb/",title:"Ldb",section:"ODIN Documentation",description:"",content:`

public bool Ldb

Value Type

Type	Description
Boolean

`}),e.add({id:1392,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Leave()

Leave a room and free all remote peers and associated medias

Info

This resets the room object for a final close use Dispose

`}),e.add({id:1393,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void Leave(string key)

Get the room and leave

Info

does NOT remove the room from the collection

Parameters

Name	Type	Description
key	String	room name

`}),e.add({id:1394,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave()

Leave a room and free all remote peers and associated medias

Info

This resets the room object for a final close use Dispose

`}),e.add({id:1395,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave(string key)

Get the room and leave

Info

does NOT remove the room from the collection

Parameters

Name	Type	Description
key	String	room name

`}),e.add({id:1396,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave()

Leave a room and free all remote peers and associated medias

Info

This resets the room object for a final close use Dispose

`}),e.add({id:1397,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave(string key)

Get the room and leave

Info

does NOT remove the room from the collection

Parameters

Name	Type	Description
key	String	room name

`}),e.add({id:1398,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave()

Leave a room and free all remote peers and associated medias

Info

This resets the room object for a final close use Dispose

`}),e.add({id:1399,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave(string key)

Get the room and leave

Info

does NOT remove the room from the collection

Parameters

Name	Type	Description
key	String	room name

`}),e.add({id:1400,href:"https://www.4players.io/odin/sdk/unity/classes/room/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave()

Leave a room and free all remote peers and associated medias

Info

This resets the room object for a final close use Dispose

`}),e.add({id:1401,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/leave/",title:"Leave",section:"ODIN Documentation",description:"",content:`

public void Leave(string key)

Get the room and leave

Info

does NOT remove the room from the collection

Parameters

Name	Type	Description
key	String	room name

`}),e.add({id:1402,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<bool> LeaveRoom(string name)

Leave a joined Room

Info

Will dispose the Room object

Parameters

Name	Type	Description
name	String	Room name

Returns

Type	Description
Task<Boolean>	true if removed from or false

`}),e.add({id:1403,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async void LeaveRoom(string roomName)

Leave and free the Room by name

Parameters

Name	Type	Description
roomName	String	Room name

`}),e.add({id:1404,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async Task<bool> LeaveRoom(string name)

Leave a joined Room

Info

Will dispose the Room object

Parameters

Name	Type	Description
name	String	Room name

Returns

Type	Description
Task<Boolean>	true if removed from or false

`}),e.add({id:1405,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async void LeaveRoom(string roomName)

Leave and free the Room by name

Parameters

Name	Type	Description
roomName	String	Room name

`}),e.add({id:1406,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async Task<bool> LeaveRoom(string name)

Leave a joined Room

Info

Will dispose the Room object

Parameters

Name	Type	Description
name	String	Room name

Returns

Type	Description
Task<Boolean>	true if removed from or false

`}),e.add({id:1407,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async void LeaveRoom(string roomName)

Leave and free the Room by name

Parameters

Name	Type	Description
roomName	String	Room name

`}),e.add({id:1408,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async Task<bool> LeaveRoom(string name)

Leave a joined Room

Info

Will dispose the Room object

Parameters

Name	Type	Description
name	String	Room name

Returns

Type	Description
Task<Boolean>	true if removed from or false

`}),e.add({id:1409,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async void LeaveRoom(string roomName)

Leave and free the Room by name

Parameters

Name	Type	Description
roomName	String	Room name

`}),e.add({id:1410,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async Task<bool> LeaveRoom(string name)

Leave a joined Room

Info

Will dispose the Room object

Parameters

Name	Type	Description
name	String	Room name

Returns

Type	Description
Task<Boolean>	true if removed from or false

`}),e.add({id:1411,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/leaveroom/",title:"LeaveRoom",section:"ODIN Documentation",description:"",content:`

public async void LeaveRoom(string roomName)

Leave and free the Room by name

Parameters

Name	Type	Description
roomName	String	Room name

`}),e.add({id:1412,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/left/",title:"Left",section:"ODIN Documentation",description:"Fired when the local user disconnected from the room (left).",content:`

public Left: OdinLeftEvent

Fired when the local user disconnected from the room (left).

Parameters

Name	Type	Description
samplerate	UInt32	encoder samplerate
stereo	Boolean	encoder channel flag
encoder	MediaEncoder	started encoder or null

Returns

Type	Description
Boolean	true on start or false

`}),e.add({id:1415,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Linux = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1416,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Linux = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1417,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Linux = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1418,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Linux = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1419,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Linux = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1420,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/linux/",title:"Linux",section:"ODIN Documentation",description:"",content:`

Linux = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1421,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/log/",title:"Log",section:"ODIN Documentation",description:"",content:`

public bool Log

Value Type

Type	Description
Boolean

`}),e.add({id:1422,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/log/",title:"Log",section:"ODIN Documentation",description:"",content:`

public bool Log

Value Type

Type	Description
Boolean

`}),e.add({id:1423,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/log/",title:"Log",section:"ODIN Documentation",description:"",content:`

public bool Log

Value Type

Type	Description
Boolean

`}),e.add({id:1424,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/log/",title:"Log",section:"ODIN Documentation",description:"",content:`

public bool Log

Value Type

Type	Description
Boolean

`}),e.add({id:1425,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/loopback/",title:"Loopback",section:"ODIN Documentation",description:" Create and play (AudioSource) with a Microphone (AudioClip) on loop. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Loopback

Create and play (AudioSource) with a Microphone (AudioClip) on loop.

Info

Needs Platform specific Permissions i.e Microphone to work.

Value Type

Type	Description
Boolean

`}),e.add({id:1426,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/loopback/",title:"Loopback",section:"ODIN Documentation",description:" Create and play (AudioSource) with a Microphone (AudioClip) on loop. ",content:`

public bool Loopback

Create and play (AudioSource) with a Microphone (AudioClip) on loop.

Info

Needs Platform specific Permissions i.e Microphone to work.

Value Type

Type	Description
Boolean

`}),e.add({id:1427,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/loopback/",title:"Loopback",section:"ODIN Documentation",description:" Create and play (AudioSource) with a Microphone (AudioClip) on loop. ",content:`

public bool Loopback

Create and play (AudioSource) with a Microphone (AudioClip) on loop.

Info

Needs Platform specific Permissions i.e Microphone to work.

Value Type

Type	Description
Boolean

`}),e.add({id:1428,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/loopback/",title:"Loopback",section:"ODIN Documentation",description:" Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound. ",content:`

public bool Loopback

Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound.

Info

Needs Platform specific Permissions i.e Microphone to work.

Value Type

Type	Description
Boolean

`}),e.add({id:1429,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/loopback/",title:"Loopback",section:"ODIN Documentation",description:" Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound. ",content:`

public bool Loopback

Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound.

Info

Needs Platform specific Permissions i.e Microphone to work.

Value Type

Type	Description
Boolean

`}),e.add({id:1430,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/low/",title:"Low",section:"ODIN Documentation",description:" 6dB ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Low = 1

6dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1431,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/low/",title:"Low",section:"ODIN Documentation",description:" 6dB ",content:`

Low = 1

6dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1432,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/low/",title:"Low",section:"ODIN Documentation",description:" 6dB ",content:`

Low = 1

6dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1433,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/low/",title:"Low",section:"ODIN Documentation",description:" 6dB ",content:`

Low = 1

6dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1434,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/low/",title:"Low",section:"ODIN Documentation",description:" 6dB ",content:`

Low = 1

6dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1435,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

MacOSX = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1436,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

MacOSX = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1437,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

MacOSX = 1

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1438,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

MacOSX = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1439,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

MacOSX = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1440,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/macosx/",title:"MacOSX",section:"ODIN Documentation",description:"",content:`

MacOSX = 2

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:1441,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/map16/",title:"Map16",section:"ODIN Documentation",description:"",content:`

public const byte Map16 = 222

Value Type

Type	Description
Byte

`}),e.add({id:1442,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/map32/",title:"Map32",section:"ODIN Documentation",description:"",content:`

public const byte Map32 = 223

Value Type

Type	Description
Byte

`}),e.add({id:1443,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mapenumerable/",title:"MapEnumerable",section:"ODIN Documentation",description:"",content:`

public sealed class MapEnumerable : IEnumerable<KeyValuePair<string, MsgPackReader>>

Constructors

Name	Description
MapEnumerable(ref MsgPackReader)

Public Methods

Name	Description
GetEnumerator

`}),e.add({id:1444,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mapenumerable/constructor_0/",title:"MapEnumerable(ref MsgPackReader)",section:"ODIN Documentation",description:"",content:`

public MapEnumerable(ref MsgPackReader r)

Parameters

Name	Description
r

`}),e.add({id:1445,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/mapposition/",title:"MapPosition",section:"ODIN Documentation",description:" Relative position ",content:`

public Vector3 MapPosition

Relative position

Value Type

Type	Description
Vector3

`}),e.add({id:1446,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/marshalmanagedtonative/",title:"MarshalManagedToNative",section:"ODIN Documentation",description:"",content:`

public IntPtr MarshalManagedToNative(object managedObj)

Parameters

Name	Type	Description
managedObj	Object

Returns

Type	Description
IntPtr

`}),e.add({id:1447,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/marshalmanagedtonative/",title:"MarshalManagedToNative",section:"ODIN Documentation",description:"",content:`

public IntPtr MarshalManagedToNative(object managedObj)

Parameters

Name	Type	Description
managedObj	Object

Returns

Type	Description
IntPtr

`}),e.add({id:1448,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/marshalnativetomanaged/",title:"MarshalNativeToManaged",section:"ODIN Documentation",description:"",content:`

public object MarshalNativeToManaged(IntPtr pNativeData)

Parameters

Name	Type	Description
pNativeData	IntPtr

Returns

Type	Description
Object

`}),e.add({id:1449,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/marshalnativetomanaged/",title:"MarshalNativeToManaged",section:"ODIN Documentation",description:"",content:`

public object MarshalNativeToManaged(IntPtr pNativeData)

Parameters

Name	Type	Description
pNativeData	IntPtr

Returns

Type	Description
Object

`}),e.add({id:1450,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/maxdistance/",title:"MaxDistance",section:"ODIN Documentation",description:" Property of AudioSource ",content:`

public float MaxDistance { get; set; }

Property of AudioSource

Value Type

Type	Description
Single

`}),e.add({id:1451,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/maxfixarray/",title:"MaxFixArray",section:"ODIN Documentation",description:"",content:`

public const byte MaxFixArray = 159

Value Type

Type	Description
Byte

`}),e.add({id:1452,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/maxfixmap/",title:"MaxFixMap",section:"ODIN Documentation",description:"",content:`

public const byte MaxFixMap = 143

Value Type

Type	Description
Byte

`}),e.add({id:1453,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/maxfixstr/",title:"MaxFixStr",section:"ODIN Documentation",description:"",content:`

public const byte MaxFixStr = 191

Value Type

Type	Description
Byte

`}),e.add({id:1454,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/maxnegativefixint/",title:"MaxNegativeFixInt",section:"ODIN Documentation",description:"",content:`

public const byte MaxNegativeFixInt = 255

Value Type

Type	Description
Byte

`}),e.add({id:1455,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/maxpositivefixint/",title:"MaxPositiveFixInt",section:"ODIN Documentation",description:"",content:`

public const byte MaxPositiveFixInt = 127

Value Type

Type	Description
Byte

`}),e.add({id:1456,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediaactivitychangedeventpayload/media/",title:"media",section:"ODIN Documentation",description:"The media that was updated.",content:`

OdinMedia

The media that was updated.

Value Type

Type	Description
PlaybackStream

`}),e.add({id:1459,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaaddedeventargs/media/",title:"Media",section:"ODIN Documentation",description:" with ",content:`

public PlaybackStream Media

Media

Value Type

Type	Description
PlaybackStream

`}),e.add({id:1460,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaaddedeventargs/media/",title:"Media",section:"ODIN Documentation",description:" with ",content:`

public PlaybackStream Media

Media

Value Type

Type	Description
PlaybackStream

`}),e.add({id:1461,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaaddedeventargs/media/",title:"Media",section:"ODIN Documentation",description:" with ",content:`

public PlaybackStream Media

Media

Value Type

Type	Description
PlaybackStream

`}),e.add({id:1462,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/media/",title:"Media",section:"ODIN Documentation",description:"",content:`

public IMedia Media { get; set; }

Value Type

Type	Description
IMedia

`}),e.add({id:1463,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/media/",title:"Media",section:"ODIN Documentation",description:" Get Media ",content:`

public virtual IMedia Media { get; set; }

Get Media

Info

Will reset the effect if the media id has changed

Value Type

Type	Description
IMedia

`}),e.add({id:1464,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/media/",title:"Media",section:"ODIN Documentation",description:"",content:`

public IMedia Media { get; set; }

Value Type

Type	Description
IMedia

`}),e.add({id:1465,href:"https://www.4players.io/odin/sdk/unity/classes/mediaaddedeventargs/media/",title:"Media",section:"ODIN Documentation",description:" with ",content:`

public PlaybackStream Media

Media

Value Type

Type	Description
PlaybackStream

`}),e.add({id:1466,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/media_id/",title:"media_id",section:"ODIN Documentation",description:"",content:`

public UInt16 media_id

Value Type

Type	Description
UInt16

`}),e.add({id:1467,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool MediaActiveStateChangedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1468,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MediaActiveStateChangedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1469,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaActiveStateChangedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1470,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaActiveStateChangedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1471,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaActiveStateChangedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1472,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaActiveStateChangedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1473,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaActiveStateChangedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1474,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaActiveStateChangedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1475,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaActiveStateChangedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1476,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/mediaactivestatechangedevent/",title:"MediaActiveStateChangedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaActiveStateChangedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1477,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
PeerId	UInt64	peer id
Active	Boolean	state of the media

`}),e.add({id:1478,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

Inherits from:

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
PeerId	UInt64	peer id
Active	Boolean	state of the media

`}),e.add({id:1479,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
PeerId	UInt64	peer id
Active	Boolean	state of the media

`}),e.add({id:1480,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

Inherits from:

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Description
MediaStreamId	stream handle id
PeerId	peer id
Active	state of the media

`}),e.add({id:1481,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Description
MediaId	media id
PeerId	peer id
Active	state of the media
RmsDbfs	value between the peak and minimum for amplitude levels

`}),e.add({id:1482,href:"https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedeventargs/",title:"MediaActiveStateChangedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaActiveStateChanged events in the current room ",content:`

Inherits from:

public class MediaActiveStateChangedEventArgs : EventArgs

Arguments for MediaActiveStateChanged events in the current room

Properties

Name	Description
MediaStreamId	stream handle id
PeerId	peer id
Active	state of the media

`}),e.add({id:1483,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:1484,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:1485,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:1486,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaActiveStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:1487,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaActiveStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:1488,href:"https://www.4players.io/odin/sdk/unity/delegates/mediaactivestatechangedeventhandler/",title:"MediaActiveStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void MediaActiveStateChangedEventHandler(object sender, MediaActiveStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaActiveStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:1489,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1490,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1491,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1492,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1493,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1494,href:"https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedproxy/",title:"MediaActiveStateChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaActiveStateChangedProxy : UnityEvent<object, MediaActiveStateChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1495,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/mediaactivity/",title:"MediaActivity",section:"ODIN Documentation",description:"Fired when a media stream was activated or deactivated. The active flag is true if the user started to talk and false if the user stopped talking.",content:`

public MediaActivity: OdinMediaActivityEvent

Fired when a media stream was activated or deactivated. The active flag is true if the user started to talk and false if the user stopped talking.

Value Type

Type	Description
Boolean

`}),e.add({id:1500,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MediaAddedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1501,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaAddedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1502,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaAddedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1503,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaAddedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1504,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaAddedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1505,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaAddedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1506,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaAddedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1507,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaAddedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1508,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/mediaaddedevent/",title:"MediaAddedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaAddedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1509,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
Media	PlaybackStream	Media

`}),e.add({id:1510,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

Inherits from:

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
Media	PlaybackStream	Media

`}),e.add({id:1511,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
Media	PlaybackStream	Media

`}),e.add({id:1512,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

Inherits from:

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Description
PeerId	peer id
Peer	peer object
Media	Media

`}),e.add({id:1513,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Description
RoomId	room id
PeerId	peer id
MediaId	media id

`}),e.add({id:1514,href:"https://www.4players.io/odin/sdk/unity/classes/mediaaddedeventargs/",title:"MediaAddedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaAdded events in the current room ",content:`

Inherits from:

public class MediaAddedEventArgs : EventArgs

Arguments for MediaAdded events in the current room

Properties

Name	Description
PeerId	peer id
Peer	peer object
Media	Media

`}),e.add({id:1515,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1516,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1517,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1518,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1519,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1520,href:"https://www.4players.io/odin/sdk/unity/classes/mediaaddedproxy/",title:"MediaAddedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaAddedProxy : UnityEvent<object, MediaAddedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1521,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediachannels/",title:"MediaChannels",section:"ODIN Documentation",description:" Supported values for audio channel count ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Type	Description
Mono	MediaChannels	Defines a single (monaural) channel
Stereo	MediaChannels	Defines two (stereo) channels

`}),e.add({id:1522,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediachannels/",title:"MediaChannels",section:"ODIN Documentation",description:" Supported values for audio channel count ",content:`

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Type	Description
Mono	MediaChannels	Defines a single (monaural) channel
Stereo	MediaChannels	Defines two (stereo) channels

`}),e.add({id:1523,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediachannels/",title:"MediaChannels",section:"ODIN Documentation",description:" Supported values for audio channel count ",content:`

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Type	Description
Mono	MediaChannels	Defines a single (monaural) channel
Stereo	MediaChannels	Defines two (stereo) channels

`}),e.add({id:1524,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediachannels/",title:"MediaChannels",section:"ODIN Documentation",description:" Supported values for audio channel count ",content:`

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Description
Mono	Defines a single (monaural) channel
Stereo	Defines two (stereo) channels

`}),e.add({id:1525,href:"https://www.4players.io/odin/sdk/unity/enums/mediachannels/",title:"MediaChannels",section:"ODIN Documentation",description:" Supported values for audio channel count ",content:`

public enum MediaChannels : byte

Supported values for audio channel count

Properties

Name	Description
Mono	Defines a single (monaural) channel
Stereo	Defines two (stereo) channels

`}),e.add({id:1526,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/",title:"MediaCollection",section:"ODIN Documentation",description:" Internal collection of available media streams ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaCollection : IReadOnlyCollection<MediaStream>, IEqualityComparer<MediaStream>

Internal collection of available media streams

Properties

Name	Type	Description
Item[Int64]	MediaStream	Try to get a media stream by ID
Count	Int32	Count of streams in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a stream to the collection
Clear	Free and empty the collection
Contains	Determines whether the stream by id is in the collection
CopyTo	Copies stream of the collection to an array
Equals	Determines whether the streams are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a stream by handle id from the collection
SetMute	Set IsMuted on each Media

`}),e.add({id:1527,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/",title:"MediaCollection",section:"ODIN Documentation",description:" Internal collection of available media streams ",content:`

public class MediaCollection : IReadOnlyCollection<MediaStream>, IEnumerable<MediaStream>, IEnumerable, IEqualityComparer<MediaStream>

Internal collection of available media streams

Properties

Name	Type	Description
Item[Int64]	MediaStream	Try to get a media stream by ID
Count	Int32	Count of streams in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a stream to the collection
Clear	Free and empty the collection
Contains	Determines whether the stream by id is in the collection
CopyTo	Copies stream of the collection to an array
Equals	Determines whether the streams are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a stream by handle id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:1528,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/",title:"MediaCollection",section:"ODIN Documentation",description:" Internal collection of available media streams ",content:`

public class MediaCollection : IReadOnlyCollection<MediaStream>, IEqualityComparer<MediaStream>

Internal collection of available media streams

Properties

Name	Type	Description
Item[Int64]	MediaStream	Try to get a media stream by ID
Count	Int32	Count of streams in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a stream to the collection
Clear	Free and empty the collection
Contains	Determines whether the stream by id is in the collection
CopyTo	Copies stream of the collection to an array
Equals	Determines whether the streams are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a stream by handle id from the collection
SetMute	Set IsMuted on each Media

`}),e.add({id:1529,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/",title:"MediaCollection",section:"ODIN Documentation",description:" Internal collection of available media streams ",content:`

public class MediaCollection : IReadOnlyCollection<MediaStream>, IEnumerable<MediaStream>, IEnumerable, IEqualityComparer<MediaStream>

Internal collection of available media streams

Constructors

Name	Description
MediaCollection()	Internal collection of available media streams

Properties

Name	Description
Item[Int64]	Try to get a media stream by ID
Count	Count of streams in the collection
IsReadOnly	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a stream to the collection
Clear	Free and empty the collection
Contains	Determines whether the stream by id is in the collection
CopyTo	Copies stream of the collection to an array
Equals	Determines whether the streams are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a stream by handle id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:1530,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/",title:"MediaCollection",section:"ODIN Documentation",description:" Internal collection of available media streams ",content:`

public class MediaCollection : IReadOnlyCollection<MediaStream>, IEnumerable<MediaStream>, IEnumerable, IEqualityComparer<MediaStream>

Internal collection of available media streams

Constructors

Name	Description
MediaCollection()	Internal collection of available media streams

Properties

Name	Description
Item[Int64]	Try to get a media stream by ID
Count	Count of streams in the collection
IsReadOnly	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a stream to the collection
Clear	Free and empty the collection
Contains	Determines whether the stream by id is in the collection
CopyTo	Copies stream of the collection to an array
Equals	Determines whether the streams are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a stream by handle id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:1531,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/constructor_0/",title:"MediaCollection()",section:"ODIN Documentation",description:"",content:`

public MediaCollection()

Internal collection of available media streams

`}),e.add({id:1532,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/constructor_0/",title:"MediaCollection()",section:"ODIN Documentation",description:"",content:`

public MediaCollection()

Internal collection of available media streams

`}),e.add({id:1533,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/mediaconfig/",title:"MediaConfig",section:"ODIN Documentation",description:" Audio config of the media stream ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public OdinMediaConfig MediaConfig { get; }

Audio config of the media stream

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:1534,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/mediaconfig/",title:"MediaConfig",section:"ODIN Documentation",description:" Audio config of the media stream ",content:`

public OdinMediaConfig MediaConfig { get; }

Audio config of the media stream

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:1535,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/mediaconfig/",title:"MediaConfig",section:"ODIN Documentation",description:" Audio config of the media stream ",content:`

public OdinMediaConfig MediaConfig { get; }

Audio config of the media stream

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:1536,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/mediaconfig/",title:"MediaConfig",section:"ODIN Documentation",description:" Audio config of the media stream ",content:`

public OdinMediaConfig MediaConfig { get; }

Audio config of the media stream

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:1537,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/mediaconfig/",title:"MediaConfig",section:"ODIN Documentation",description:" Audio config of the media stream ",content:`

public OdinMediaConfig MediaConfig { get; }

Audio config of the media stream

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:1538,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/",title:"MediaDecoder",section:"ODIN Documentation",description:" Odin Playback Media ",content:`

public class MediaDecoder : IMedia, IDisposable

Odin Playback Media

Static Methods

Name	Description
Create	Create a new dangling output media.

Properties

Name	Description
Id	Media id
MediaProperties	Arbitrary media data
IsPaused
Samplerate	Output samplerate
Stereo	Output channel flag
Pipeline	Odin effect pipeline
Parent	Default value null indicates root or not set

Public Methods

Name	Description
GetPipeline	Get native effect pipeline
Pop	Pop output audio from the media
Push	Push output audio into the media for effect processing
Dispose	Free native media decoder

`}),e.add({id:1539,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/mediadecoder/",title:"MediaDecoder",section:"ODIN Documentation",description:" Media reference ",content:`

public MediaDecoder MediaDecoder { get; set; }

Media reference

Value Type

Type	Description
MediaDecoder

`}),e.add({id:1540,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/",title:"MediaEncoder",section:"ODIN Documentation",description:" Odin Capture Media ",content:`

public class MediaEncoder : IMedia, IDisposable

Odin Capture Media

Static Methods

Name	Description
Create	Create a new dangling input media.

Properties

Name	Description
Id	Media id
MediaProperties	Arbitrary media data
Samplerate	Input samplerate
Stereo	Input channel flag
Pipeline	Odin effect pipeline
GuardSilence	On true Single%5b%5d%2cSystem isSilent = true will not push data to the native encoder
Parent	Default value null indicates root or not set

Public Methods

Name	Description
GetPipeline	Get native effect pipeline
PopAll	Pop all audio datagrams into the stack
Pop	Pop one datagram from the media
Push	Push samples to the media
Dispose	Free native media encoder

`}),e.add({id:1541,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinaudiodatareceivedeventpayload/mediaid/",title:"mediaId",section:"ODIN Documentation",description:"The ID of the media that sent the audio data.",content:`

public mediaId: number

The ID of the media that sent the audio data.

`}),e.add({id:1542,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaactivityeventpayload/mediaid/",title:"mediaId",section:"ODIN Documentation",description:"The ID of the media that changed the activity.",content:`

public mediaId: number

The ID of the media that changed the activity.

`}),e.add({id:1543,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaaddedeventpayload/mediaid/",title:"mediaId",section:"ODIN Documentation",description:"The ID of the media that was added.",content:`

public mediaId: number

The ID of the media that was added.

`}),e.add({id:1544,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaremovedeventpayload/mediaid/",title:"mediaId",section:"ODIN Documentation",description:"The ID of the media that was removed.",content:`

public mediaId: number

The ID of the media that was removed.

`}),e.add({id:1545,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedeventargs/mediaid/",title:"MediaId",section:"ODIN Documentation",description:" media id ",content:`

public ushort MediaId { get; }

media id

Value Type

Type	Description
UInt16

`}),e.add({id:1546,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaaddedeventargs/mediaid/",title:"MediaId",section:"ODIN Documentation",description:" media id ",content:`

public ushort MediaId { get; }

media id

Value Type

Type	Description
UInt16

`}),e.add({id:1547,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaremovedeventargs/mediaid/",title:"MediaId",section:"ODIN Documentation",description:" stream handle id ",content:`

public ushort MediaId { get; }

stream handle id

Value Type

Type	Description
UInt16

`}),e.add({id:1548,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedeventargs/mediaids/",title:"MediaIds",section:"ODIN Documentation",description:"",content:`

public ushort[] MediaIds

Value Type

Type	Description
UInt16[]

`}),e.add({id:1549,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/",title:"MediaPipeline",section:"ODIN Documentation",description:" Odin audio pipeline ",content:`

public class MediaPipeline

Odin audio pipeline

Constructors

Name	Description
MediaPipeline(OdinPipelineHandle)

Public Methods

Name	Description
GetEffects	Get Pipeline effects collection
GetNextIndex	Calculate the next available index based on MediaPipeline entries
GetEffectCount	Get the current effect count of the native pipeline
GetEffectId	Get the effect id of the native pipeline by index id
AddApmEffect	Insert a apm effect and sets the apm config
InsertApmEffect	Insert a apm effect to native pipeline
AddCustomEffect	Insert a custom effect and sets the Media where T marks Serialize/Deserialize structures
InsertCustomEffect	Insert a custom effect to native pipeline
AddVadEffect	Insert a vad effect
InsertVadEffect	Insert a vad effect to native pipeline
MoveEffect	Moves a effect in the native pipeline to a new index
RemoveEffect	Removes a effect from the native pipeline

`}),e.add({id:1550,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/constructor_0/",title:"MediaPipeline(OdinPipelineHandle)",section:"ODIN Documentation",description:"",content:`

public MediaPipeline(OdinPipelineHandle handle)

Parameters

Name	Description
handle

`}),e.add({id:1551,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/mediaproperties/",title:"MediaProperties",section:"ODIN Documentation",description:" Arbitrary media data ",content:`

public MediaRpcProperties MediaProperties { get; }

Arbitrary media data

Value Type

Type	Description
MediaRpcProperties

`}),e.add({id:1552,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/mediaproperties/",title:"MediaProperties",section:"ODIN Documentation",description:" Arbitrary media data ",content:`

public MediaRpcProperties MediaProperties { get; }

Arbitrary media data

Value Type

Type	Description
MediaRpcProperties

`}),e.add({id:1553,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/mediaremoved/",title:"MediaRemoved",section:"ODIN Documentation",description:"Fired when a media stream was removed from a peer. This happens for example if a peer removes a microphone from the room",content:`

public MediaRemoved: OdinMediaRemovedEvent

Fired when a media stream was removed from a peer. This happens for example if a peer removes a microphone from the room

Value Type

Type	Description
Boolean

`}),e.add({id:1555,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MediaRemovedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1556,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaRemovedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1557,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaRemovedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1558,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaRemovedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1559,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaRemovedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1560,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaRemovedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1561,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaRemovedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1562,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MediaRemovedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1563,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/mediaremovedevent/",title:"MediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

public bool MediaRemovedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1564,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
Peer	Peer	peer object

`}),e.add({id:1565,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

Inherits from:

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
Peer	Peer	peer object

`}),e.add({id:1566,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Type	Description
MediaStreamId	Int64	stream handle id
Peer	Peer	peer object

`}),e.add({id:1567,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

Inherits from:

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Description
MediaStreamId	stream handle id
Peer	peer object

`}),e.add({id:1568,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Description
MediaId	stream handle id
PeerId	peer object

`}),e.add({id:1569,href:"https://www.4players.io/odin/sdk/unity/classes/mediaremovedeventargs/",title:"MediaRemovedEventArgs",section:"ODIN Documentation",description:" Arguments for MediaRemoved events in the current room ",content:`

Inherits from:

public class MediaRemovedEventArgs : EventArgs

Arguments for MediaRemoved events in the current room

Properties

Name	Description
MediaStreamId	stream handle id
Peer	peer object

`}),e.add({id:1570,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1571,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1572,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1573,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1574,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1575,href:"https://www.4players.io/odin/sdk/unity/classes/mediaremovedproxy/",title:"MediaRemovedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MediaRemovedProxy : UnityEvent<object, MediaRemovedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1576,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/mediarpc/",title:"MediaRpc",section:"ODIN Documentation",description:" RPC data map ",content:`

public struct MediaRpc

RPC data map

Properties

Name	Description
Id	media id
Properties	arbitrary media data
Paused	media state

`}),e.add({id:1577,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediarpcproperties/",title:"MediaRpcProperties",section:"ODIN Documentation",description:" arbitrary media data ",content:`

public class MediaRpcProperties

arbitrary media data

Properties

Name	Description
Kind	preset field "Audio"
uId	preset field of an unique id

`}),e.add({id:1578,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/medias/",title:"medias",section:"ODIN Documentation",description:"A list of media instances owned by the peer.",content:`

Map<number><OdinMedia>

A list of media instances owned by the peer.

Value Type

Type	Description
MediaCollection

`}),e.add({id:1580,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/medias/",title:"Medias",section:"ODIN Documentation",description:" Associated medias of this peer ",content:`

public MediaCollection Medias { get; }

Associated medias of this peer

Value Type

Type	Description
MediaCollection

`}),e.add({id:1581,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/medias/",title:"Medias",section:"ODIN Documentation",description:" Associated medias of this peer ",content:`

public MediaCollection Medias { get; }

Associated medias of this peer

Value Type

Type	Description
MediaCollection

`}),e.add({id:1582,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/medias/",title:"Medias",section:"ODIN Documentation",description:" Associated medias of this peer ",content:`

public MediaCollection Medias { get; }

Associated medias of this peer

Value Type

Type	Description
MediaCollection

`}),e.add({id:1583,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/medias/",title:"Medias",section:"ODIN Documentation",description:" Peer output medias ",content:`

public ConcurrentDictionary<ushort, MediaDecoder> Medias { get; }

Peer output medias

Value Type

Type	Description
ConcurrentDictionary<UInt16,MediaDecoder>

`}),e.add({id:1584,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/peerrpc/medias/",title:"Medias",section:"ODIN Documentation",description:" peer decoders ",content:`

public List<MediaRpc> Medias

peer decoders

Value Type

Type	Description
List<MediaRpc>

`}),e.add({id:1585,href:"https://www.4players.io/odin/sdk/unity/classes/peer/medias/",title:"Medias",section:"ODIN Documentation",description:" Associated medias of this peer ",content:`

public MediaCollection Medias { get; }

Associated medias of this peer

Value Type

Type	Description
MediaCollection

`}),e.add({id:1586,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediasamplerate/",title:"MediaSampleRate",section:"ODIN Documentation",description:" Supported audio sample rate values ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Type	Description
Device_Min	MediaSampleRate	Hardware device min samplerate
Device_Max	MediaSampleRate	Hardware device max samplerate
Hz8000	MediaSampleRate	8khz
Hz11025	MediaSampleRate	11.025khz
Hz12000	MediaSampleRate	12khz
Hz16000	MediaSampleRate	16khz
Hz22050	MediaSampleRate	22.05khz
Hz24000	MediaSampleRate	24khz
Hz32000	MediaSampleRate	32khz
Hz44100	MediaSampleRate	44.1khz
Hz48000	MediaSampleRate	48khz
Hz96000	MediaSampleRate	96khz
Hz128000	MediaSampleRate	128khz
Hz144000	MediaSampleRate	144khz
Hz192000	MediaSampleRate	192khz

`}),e.add({id:1587,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediasamplerate/",title:"MediaSampleRate",section:"ODIN Documentation",description:" Supported audio sample rate values ",content:`

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Type	Description
Device_Min	MediaSampleRate	Hardware device min samplerate
Device_Max	MediaSampleRate	Hardware device max samplerate
Hz8000	MediaSampleRate	8khz
Hz11025	MediaSampleRate	11.025khz
Hz12000	MediaSampleRate	12khz
Hz16000	MediaSampleRate	16khz
Hz22050	MediaSampleRate	22.05khz
Hz24000	MediaSampleRate	24khz
Hz32000	MediaSampleRate	32khz
Hz44100	MediaSampleRate	44.1khz
Hz48000	MediaSampleRate	48khz
Hz96000	MediaSampleRate	96khz
Hz128000	MediaSampleRate	128khz
Hz144000	MediaSampleRate	144khz
Hz192000	MediaSampleRate	192khz

`}),e.add({id:1588,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediasamplerate/",title:"MediaSampleRate",section:"ODIN Documentation",description:" Supported audio sample rate values ",content:`

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Type	Description
Device_Min	MediaSampleRate	Hardware device min samplerate
Device_Max	MediaSampleRate	Hardware device max samplerate
Hz8000	MediaSampleRate	8khz
Hz11025	MediaSampleRate	11.025khz
Hz12000	MediaSampleRate	12khz
Hz16000	MediaSampleRate	16khz
Hz22050	MediaSampleRate	22.05khz
Hz24000	MediaSampleRate	24khz
Hz32000	MediaSampleRate	32khz
Hz44100	MediaSampleRate	44.1khz
Hz48000	MediaSampleRate	48khz
Hz96000	MediaSampleRate	96khz
Hz128000	MediaSampleRate	128khz
Hz144000	MediaSampleRate	144khz
Hz192000	MediaSampleRate	192khz

`}),e.add({id:1589,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediasamplerate/",title:"MediaSampleRate",section:"ODIN Documentation",description:" Supported audio sample rate values ",content:`

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Description
Device_Min	Hardware device min samplerate
Device_Max	Hardware device max samplerate
Hz8000	8khz
Hz11025	11.025khz
Hz12000	12khz
Hz16000	16khz
Hz22050	22.05khz
Hz24000	24khz
Hz32000	32khz
Hz44100	44.1khz
Hz48000	48khz
Hz96000	96khz
Hz128000	128khz
Hz144000	144khz
Hz192000	192khz

`}),e.add({id:1590,href:"https://www.4players.io/odin/sdk/unity/enums/mediasamplerate/",title:"MediaSampleRate",section:"ODIN Documentation",description:" Supported audio sample rate values ",content:`

public enum MediaSampleRate : uint

Supported audio sample rate values

Properties

Name	Description
Device_Min	Hardware device min samplerate
Device_Max	Hardware device max samplerate
Hz8000	8khz
Hz11025	11.025khz
Hz12000	12khz
Hz16000	16khz
Hz22050	22.05khz
Hz24000	24khz
Hz32000	32khz
Hz44100	44.1khz
Hz48000	48khz
Hz96000	96khz
Hz128000	128khz
Hz144000	144khz
Hz192000	192khz

`}),e.add({id:1591,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinpeerevents/mediastarted/",title:"MediaStarted",section:"ODIN Documentation",description:"Peer added a new media stream.",content:`

OdinMediaStartedStoppedEvent

Peer added a new media stream.

Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Public Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1596,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/",title:"MediaStream",section:"ODIN Documentation",description:" Base stream ",content:`

public abstract class MediaStream : IDisposable

Base stream

Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Boolean	Indicates wether or not the media stream handle is invalid or closed

Public Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1597,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/",title:"MediaStream",section:"ODIN Documentation",description:" Base stream ",content:`

public abstract class MediaStream : IVideoStream, IAudioStream, IDisposable

Base stream

Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Public Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1598,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/",title:"MediaStream",section:"ODIN Documentation",description:" Base stream ",content:`

public abstract class MediaStream : IDisposable

Base stream

Constructors

Name	Description
MediaStream(OdinMediaConfig)	Base stream

Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Public Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1599,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/",title:"MediaStream",section:"ODIN Documentation",description:" Base stream ",content:`

public abstract class MediaStream : IDisposable

Base stream

Constructors

Name	Description
MediaStream(OdinMediaConfig)	Base stream

Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Public Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1600,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/constructor_0/",title:"MediaStream(OdinMediaConfig)",section:"ODIN Documentation",description:"",content:`

public MediaStream(OdinMediaConfig config)

Base stream

Parameters

Name	Description
config	audio stream configuration

`}),e.add({id:1601,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/constructor_0/",title:"MediaStream(OdinMediaConfig)",section:"ODIN Documentation",description:"",content:`

public MediaStream(OdinMediaConfig config)

Base stream

Parameters

Name	Description
config	audio stream configuration

`}),e.add({id:1602,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaactivestatechangedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1603,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaremovedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1604,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public long MediaStreamId { get; set; }

Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.

Info

Invalid values will cause errors.

Value Type

Type	Description
Int64

`}),e.add({id:1605,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaactivestatechangedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1606,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaremovedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1607,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias. ",content:`

public long MediaStreamId { get; set; }

Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.

Info

Invalid values will cause errors.

Value Type

Type	Description
Int64

`}),e.add({id:1608,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaactivestatechangedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1609,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaremovedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1610,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias. ",content:`

public long MediaStreamId { get; set; }

Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.

Info

Invalid values will cause errors.

Value Type

Type	Description
Int64

`}),e.add({id:1611,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaactivestatechangedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1612,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaremovedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1613,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias. ",content:`

public long MediaStreamId { get; set; }

Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.

Info

Invalid values will cause errors.

Value Type

Type	Description
Int64

`}),e.add({id:1614,href:"https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1615,href:"https://www.4players.io/odin/sdk/unity/classes/mediaremovedeventargs/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" stream handle id ",content:`

public long MediaStreamId { get; }

stream handle id

Value Type

Type	Description
Int64

`}),e.add({id:1616,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/mediastreamid/",title:"MediaStreamId",section:"ODIN Documentation",description:" Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias. ",content:`

public long MediaStreamId { get; set; }

Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.

Info

Invalid values will cause errors.

Value Type

Type	Description
Int64

`}),e.add({id:1617,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmessagereceivedeventpayload/message/",title:"message",section:"ODIN Documentation",description:"A byte array with the message.",content:`

Uint8Array

A byte array with the message.

`}),e.add({id:1618,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmessagereceivedeventpayload/messagedata/",title:"messageData",section:"ODIN Documentation",description:"The message data received from the peer.",content:`

public messageData: Uint8Array

The message data received from the peer.

`}),e.add({id:1619,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/messagepackextension/",title:"MessagePackExtension",section:"ODIN Documentation",description:"",content:`

public struct MessagePackExtension

Properties

Name	Description
TypeCode
Data

`}),e.add({id:1620,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagepackreaderexception/",title:"MessagePackReaderException",section:"ODIN Documentation",description:"",content:`

Inherits from:

public class MessagePackReaderException : Exception, ISerializable, _Exception

Constructors

Name	Description
MessagePackReaderException()
MessagePackReaderException(String)

`}),e.add({id:1621,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagepackreaderexception/constructor_0/",title:"MessagePackReaderException()",section:"ODIN Documentation",description:"",content:`

public MessagePackReaderException()

`}),e.add({id:1622,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagepackreaderexception/constructor_1/",title:"MessagePackReaderException(String)",section:"ODIN Documentation",description:"",content:`

public MessagePackReaderException(string message)

Parameters

Name	Description
message

`}),e.add({id:1623,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/messagereceived/",title:"MessageReceived",section:"ODIN Documentation",description:"Fired when a remote peer sent a message to the room.",content:`

public MessageReceived: OdinMessageReceivedEvent

Fired when a remote peer sent a message to the room.

Value Type

Type	Description
Boolean

`}),e.add({id:1627,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MessageReceivedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1628,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MessageReceivedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1629,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

public bool MessageReceivedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1630,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MessageReceivedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1631,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

public bool MessageReceivedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1632,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MessageReceivedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1633,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

public bool MessageReceivedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1634,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool MessageReceivedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:1635,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/messagereceivedevent/",title:"MessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

public bool MessageReceivedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:1636,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Data	Byte[]	arbitrary data

`}),e.add({id:1637,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

Inherits from:

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Data	Byte[]	arbitrary data

`}),e.add({id:1638,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Data	Byte[]	arbitrary data

`}),e.add({id:1639,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

Inherits from:

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Description
PeerId	peer id
Data	arbitrary data

`}),e.add({id:1640,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Description
PeerId	peer id
Data	arbitrary data

`}),e.add({id:1641,href:"https://www.4players.io/odin/sdk/unity/classes/messagereceivedeventargs/",title:"MessageReceivedEventArgs",section:"ODIN Documentation",description:" Arguments for MessageReceived events in the current room ",content:`

Inherits from:

public class MessageReceivedEventArgs : EventArgs

Arguments for MessageReceived events in the current room

Properties

Name	Description
PeerId	peer id
Data	arbitrary data

`}),e.add({id:1642,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:1643,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:1644,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:1645,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1646,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:1647,href:"https://www.4players.io/odin/sdk/unity/classes/messagereceivedproxy/",title:"MessageReceivedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class MessageReceivedProxy : UnityEvent<object, MessageReceivedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

The callback proxy for OnMessageReceived callback functions. You’ll receive the sender of the message in the object parameter and details about the message in a MessageReceivedEventArgs class instance.

Example

MessageReceivedProxy Example

class Message
{
	public string text;
	public string type;
}

class MyMessageHandler : MonoBehaviour
{
	public void OnMessageReceived(object sender, MessageReceivedEventArgs args)
	{
		// Get the peer id
		ulong peerId = args.PeerId;

		// Get the data
		byte[] bytes = args.Data;

		// Serialize data in your own classes (just an example, add error handling)
		var bytesAsString = Encoding.UTF8.GetString(bytes);
        var message = JsonConvert.DeserializeObject<Message>(bytesAsString);

        // Show a text chat message
        if (message.type == "chat") {
            UI.ShowIncomingChatMessage(message.text);
        }
	}

	public void SendChatMessage(Room room, string chatMessage)
	{
		var message = new Message{
			type = "chat";
			text = chatMessage;
		}
		var stringMessage = JsonConvert.SerializeObject(message, Formatting.None);
        var bytes = Encoding.UTF8.GetBytes(stringMessage);
		room.SendMessage(bytes);
	}
}

`}),e.add({id:1648,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/notification/methodindex/",title:"MethodIndex",section:"ODIN Documentation",description:" string field (method) ",content:`

public const int MethodIndex = 1

string field (method)

Value Type

Type	Description
Int32

`}),e.add({id:1649,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/request/methodindex/",title:"MethodIndex",section:"ODIN Documentation",description:" string field (method) ",content:`

public const int MethodIndex = 2

string field (method)

Value Type

Type	Description
Int32

`}),e.add({id:1650,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/microphone/",title:"Microphone",section:"ODIN Documentation",description:" Unity Component that handles one Microphone where data gets routed through (n) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MicrophoneReader Microphone

Unity Component that handles one Microphone where data gets routed through (n) Media

Value Type

Type	Description
MicrophoneReader

`}),e.add({id:1651,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/microphone/",title:"Microphone",section:"ODIN Documentation",description:" Unity Component that handles one Microphone where data gets routed through (n) ",content:`

public MicrophoneReader Microphone

Unity Component that handles one Microphone where data gets routed through (n) Media

Value Type

Type	Description
MicrophoneReader

`}),e.add({id:1652,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/microphone/",title:"Microphone",section:"ODIN Documentation",description:" Unity Component that handles one Microphone where data gets routed through (n) ",content:`

public MicrophoneReader Microphone

Unity Component that handles one Microphone where data gets routed through (n) Media

Value Type

Type	Description
MicrophoneReader

`}),e.add({id:1653,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/microphone/",title:"Microphone",section:"ODIN Documentation",description:" Unity Component that handles one Microphone where data gets routed through (n) ",content:`

public MicrophoneReader Microphone

Unity Component that handles one Microphone where data gets routed through (n) Media

Value Type

Type	Description
MicrophoneReader

`}),e.add({id:1654,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/microphone/",title:"Microphone",section:"ODIN Documentation",description:" Unity Component that handles one Microphone where data gets routed through (n) ",content:`

public MicrophoneReader Microphone

Unity Component that handles one Microphone where data gets routed through (n) Media

Value Type

Type	Description
MicrophoneReader

`}),e.add({id:1655,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

`}),e.add({id:1656,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

`}),e.add({id:1657,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

`}),e.add({id:1658,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

Parameters

Name	Type	Description
buffer	Single[]
position	Int32

`}),e.add({id:1659,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

Parameters

Name	Type	Description
buffer	Single[]
position	Int32

`}),e.add({id:1660,href:"https://www.4players.io/odin/sdk/unity/delegates/microphonecallbackdelegate/",title:"MicrophoneCallbackDelegate",section:"ODIN Documentation",description:"",content:`

public delegate void MicrophoneCallbackDelegate(float[] buffer, int position);

Parameters

Name	Type	Description
buffer	Single[]
position	Int32

`}),e.add({id:1661,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/microphonechannels/",title:"MicrophoneChannels",section:"ODIN Documentation",description:"",content:`

public int MicrophoneChannels { get; }

Value Type

Type	Description
Int32

`}),e.add({id:1662,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/microphonemedia/",title:"MicrophoneMedia",section:"ODIN Documentation",description:" Current room microphone data route ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MicrophoneStream MicrophoneMedia { get; }

Current room microphone data route

Value Type

Type	Description
MicrophoneStream

`}),e.add({id:1663,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/microphonemedia/",title:"MicrophoneMedia",section:"ODIN Documentation",description:" Current room microphone data route ",content:`

public MicrophoneStream MicrophoneMedia { get; }

Current room microphone data route

Value Type

Type	Description
MicrophoneStream

`}),e.add({id:1664,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/microphonemedia/",title:"MicrophoneMedia",section:"ODIN Documentation",description:" Current room microphone data route ",content:`

public MicrophoneStream MicrophoneMedia { get; }

Current room microphone data route

Value Type

Type	Description
MicrophoneStream

`}),e.add({id:1665,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/microphonemedia/",title:"MicrophoneMedia",section:"ODIN Documentation",description:" Current room microphone data route ",content:`

public MicrophoneStream MicrophoneMedia { get; }

Current room microphone data route

Value Type

Type	Description
MicrophoneStream

`}),e.add({id:1666,href:"https://www.4players.io/odin/sdk/unity/classes/room/microphonemedia/",title:"MicrophoneMedia",section:"ODIN Documentation",description:" Current room microphone data route ",content:`

public MicrophoneStream MicrophoneMedia { get; }

Current room microphone data route

Value Type

Type	Description
MicrophoneStream

`}),e.add({id:1667,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/",title:"MicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Type	Description
HasPermission	Boolean	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Boolean
ContinueRecording	Boolean
AudioClipLength	Int32
OverrideSampleRate	Boolean	Use set DeviceSampleRate on false
SampleRate	MediaSampleRate	The recording Core
CustomInputDevice	Boolean
InputDevice	String
AutostartListen	Boolean	Use (Microphone.Start) in MicrophoneReader
CustomMicVolumeScale	Boolean
MicVolumeScale	Single
Loopback	Boolean	Create and play (AudioSource) with a Microphone (AudioClip) on loop.
OnMicrophoneData	MicrophoneCallbackDelegate	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
MuteRoomMicrophone	Request SetMicrophoneMute(System to mute by room
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1668,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/",title:"MicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN ",content:`

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Type	Description
HasPermission	Boolean	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Boolean	Skips registered PushAudio for the OnMicrophoneData event
SilenceCapturedAudio	Boolean	Zero out the event audio buffer for PushAudio.
ContinueRecording	Boolean
AudioClipLength	Int32
OverrideSampleRate	Boolean	Use set DeviceSampleRate on false
SampleRate	MediaSampleRate	The recording Core
CustomInputDevice	Boolean	Enable/Disable the use of InputDevice as a new/fixed device name
InputDevice	String	The device name to use as microphone in Unity. (i.e Microphone.Start)
AutostartListen	Boolean	Use (Microphone.Start) in MicrophoneReader
CustomMicVolumeScale	Boolean
MicVolumeScale	Single
Loopback	Boolean	Create and play (AudioSource) with a Microphone (AudioClip) on loop.
OnMicrophoneData	MicrophoneCallbackDelegate	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1669,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/",title:"MicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN ",content:`

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Type	Description
HasPermission	Boolean	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Boolean	Skips registered PushAudio for the OnMicrophoneData event
SilenceCapturedAudio	Boolean	Zero out the event audio buffer for PushAudio.
ContinueRecording	Boolean
AudioClipLength	Int32
OverrideSampleRate	Boolean	Use set DeviceSampleRate on false
SampleRate	MediaSampleRate	The recording Core
CustomInputDevice	Boolean	Enable/Disable the use of InputDevice as a new/fixed device name
InputDevice	String	The device name to use as microphone in Unity. (i.e Microphone.Start)
AutostartListen	Boolean	Use (Microphone.Start) in MicrophoneReader
CustomMicVolumeScale	Boolean
MicVolumeScale	Single
Loopback	Boolean	Create and play (AudioSource) with a Microphone (AudioClip) on loop.
OnMicrophoneData	MicrophoneCallbackDelegate	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1670,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/",title:"MicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN ",content:`

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Description
HasPermission	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Skips registered PushAudio for the OnMicrophoneData event
SilenceCapturedAudio	Zero out the event audio buffer for PushAudio.
ContinueRecording
AudioClipLength
OverrideSampleRate	Use set OdinEditorConfig on false
SampleRate	The recording Core
CustomInputDevice	Enable/Disable the use of MicrophoneReader as a new/fixed device name
InputDevice	The device name to use as microphone in Unity. (i.e Microphone.Start )
AutostartListen	Use (Microphone.Start) in MicrophoneReader
CustomMicVolumeScale
MicVolumeScale
Loopback	Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound.
OnMicrophoneData	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1671,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/",title:"MicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN ",content:`

https://github.com/msgpack/msgpack/blob/master/spec.md

public class MicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

Properties

Name	Description
HasPermission	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Skips registered PushAudio for the OnMicrophoneData event
SilenceCapturedAudio	Zero out the event audio buffer for PushAudio.
ContinueRecording
AudioClipLength
OverrideSampleRate	Use set DeviceSampleRate on false
SampleRate	The recording Core
CustomInputDevice	Enable/Disable the use of InputDevice as a new/fixed device name
InputDevice	The device name to use as microphone in Unity. (i.e Microphone.Start )
AutostartListen	Use (Microphone.Start) in MicrophoneReader
CustomMicVolumeScale
MicVolumeScale
Loopback	Create and play (AudioSource) with a Microphone (AudioClip) on loop. Odin APM Settings are not applied in the loopback sound.
OnMicrophoneData	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1672,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/microphonesamplerate/",title:"MicrophoneSamplerate",section:"ODIN Documentation",description:"",content:`

public int MicrophoneSamplerate { get; }

Value Type

Type	Description
Int32

`}),e.add({id:1673,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonestream/",title:"MicrophoneStream",section:"ODIN Documentation",description:" Representation of a write only audio stream ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Inherits from: MediaStream

public class MicrophoneStream : MediaStream, IVideoStream, IAudioStream, IDisposable

Representation of a write only audio stream

Public Methods

Name	Description
AudioReadData	AudioReadData and AudioReadDataAsync are not supported!
AudioReadDataTask	AudioReadData and AudioReadDataAsync are not supported!
AudioReadDataAsync	AudioReadData and AudioReadDataAsync are not supported!
AudioDataLength	Get the number of samples available in the audio buffer.

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1674,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonestream/",title:"MicrophoneStream",section:"ODIN Documentation",description:" Representation of a write only audio stream ",content:`

Inherits from: MediaStream

public class MicrophoneStream : MediaStream, IDisposable

Representation of a write only audio stream

Public Methods

Name	Description
AudioStats	AudioReadData and AudioReadDataAsync are not supported!
AudioReset	AudioReset is not supported!
AudioReadData	AudioReadData is not supported!
AudioReadDataTask	AudioReadDataTask is not supported!
AudioReadDataAsync	AudioReadDataAsync is not supported!

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Boolean	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1675,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonestream/",title:"MicrophoneStream",section:"ODIN Documentation",description:" Representation of a write only audio stream ",content:`

Inherits from: MediaStream

public class MicrophoneStream : MediaStream, IVideoStream, IAudioStream, IDisposable

Representation of a write only audio stream

Public Methods

Name	Description
AudioReadData	AudioReadData and AudioReadDataAsync are not supported!
AudioReadDataTask	AudioReadData and AudioReadDataAsync are not supported!
AudioReadDataAsync	AudioReadData and AudioReadDataAsync are not supported!
AudioDataLength	Get the number of samples available in the audio buffer.

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1676,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/",title:"MicrophoneStream",section:"ODIN Documentation",description:" Representation of a write only audio stream ",content:`

Inherits from: MediaStream

public class MicrophoneStream : MediaStream, IDisposable

Representation of a write only audio stream

Constructors

Name	Description
MicrophoneStream()
MicrophoneStream(OdinMediaConfig)

Properties

Name	Description
IsMuted

Public Methods

Name	Description
MuteStream
AudioPushData
AudioStats	AudioReadData and AudioReadDataAsync are not supported!
AudioReset	AudioReset is not supported!
AudioReadData	AudioReadData is not supported!
AudioReadDataTask	AudioReadDataTask is not supported!
AudioReadDataAsync	AudioReadDataAsync is not supported!

Inherited Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1677,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/",title:"MicrophoneStream",section:"ODIN Documentation",description:" Representation of a write only audio stream ",content:`

Inherits from: MediaStream

public class MicrophoneStream : MediaStream, IDisposable

Representation of a write only audio stream

Constructors

Name	Description
MicrophoneStream()
MicrophoneStream(OdinMediaConfig)

Properties

Name	Description
IsMuted

Public Methods

Name	Description
MuteStream
AudioPushData
AudioStats	AudioReadData and AudioReadDataAsync are not supported!
AudioReset	AudioReset is not supported!
AudioReadData	AudioReadData is not supported!
AudioReadDataTask	AudioReadDataTask is not supported!
AudioReadDataAsync	AudioReadDataAsync is not supported!

Inherited Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:1678,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/constructor_0/",title:"MicrophoneStream()",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream()

`}),e.add({id:1679,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/constructor_0/",title:"MicrophoneStream()",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream()

`}),e.add({id:1680,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/constructor_1/",title:"MicrophoneStream(OdinMediaConfig)",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream(OdinMediaConfig config)

Parameters

Name	Description
config

`}),e.add({id:1681,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/constructor_1/",title:"MicrophoneStream(OdinMediaConfig)",section:"ODIN Documentation",description:"",content:`

public MicrophoneStream(OdinMediaConfig config)

Parameters

Name	Description
config

`}),e.add({id:1682,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1683,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1684,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1685,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1686,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1687,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/micvolumescale/",title:"MicVolumeScale",section:"ODIN Documentation",description:"",content:`

public float MicVolumeScale

Value Type

Type	Description
Single

`}),e.add({id:1688,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/min_dbfs/",title:"MIN_DBFS",section:"ODIN Documentation",description:"",content:`

public const float MIN_DBFS = -897.069F

Value Type

Type	Description
Single

`}),e.add({id:1689,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/mindistance/",title:"MinDistance",section:"ODIN Documentation",description:" Property of AudioSource ",content:`

public float MinDistance { get; set; }

Property of AudioSource

Value Type

Type	Description
Single

`}),e.add({id:1690,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/minfixarray/",title:"MinFixArray",section:"ODIN Documentation",description:"",content:`

public const byte MinFixArray = 144

Value Type

Type	Description
Byte

`}),e.add({id:1691,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/minfixmap/",title:"MinFixMap",section:"ODIN Documentation",description:"",content:`

public const byte MinFixMap = 128

Value Type

Type	Description
Byte

`}),e.add({id:1692,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/minfixstr/",title:"MinFixStr",section:"ODIN Documentation",description:"",content:`

public const byte MinFixStr = 160

Value Type

Type	Description
Byte

`}),e.add({id:1693,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/minnegativefixint/",title:"MinNegativeFixInt",section:"ODIN Documentation",description:"",content:`

public const byte MinNegativeFixInt = 224

Value Type

Type	Description
Byte

`}),e.add({id:1694,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/minpositivefixint/",title:"MinPositiveFixInt",section:"ODIN Documentation",description:"",content:`

public const byte MinPositiveFixInt = 0

Value Type

Type	Description
Byte

`}),e.add({id:1695,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/moderate/",title:"Moderate",section:"ODIN Documentation",description:" 12 dB ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Moderate = 2

12 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1696,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/moderate/",title:"Moderate",section:"ODIN Documentation",description:" 12 dB ",content:`

Moderate = 2

12 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1697,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/moderate/",title:"Moderate",section:"ODIN Documentation",description:" 12 dB ",content:`

Moderate = 2

12 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1698,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/moderate/",title:"Moderate",section:"ODIN Documentation",description:" 12 dB ",content:`

Moderate = 2

12 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1699,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/moderate/",title:"Moderate",section:"ODIN Documentation",description:" 12 dB ",content:`

Moderate = 2

12 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1700,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/mediachannels/mono/",title:"Mono",section:"ODIN Documentation",description:" Defines a single (monaural) channel ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Mono = 1

Defines a single (monaural) channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:1701,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediachannels/mono/",title:"Mono",section:"ODIN Documentation",description:" Defines a single (monaural) channel ",content:`

Mono = 1

Defines a single (monaural) channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:1702,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediachannels/mono/",title:"Mono",section:"ODIN Documentation",description:" Defines a single (monaural) channel ",content:`

Mono = 1

Defines a single (monaural) channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:1703,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediachannels/mono/",title:"Mono",section:"ODIN Documentation",description:" Defines a single (monaural) channel ",content:`

Mono = 1

Defines a single (monaural) channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:1704,href:"https://www.4players.io/odin/sdk/unity/enums/mediachannels/mono/",title:"Mono",section:"ODIN Documentation",description:" Defines a single (monaural) channel ",content:`

Mono = 1

Defines a single (monaural) channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:1705,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/moveeffect/",title:"MoveEffect",section:"ODIN Documentation",description:"",content:`

public bool MoveEffect(uint effectId, uint oldIndexId, ref uint newIndexId)

Moves a effect in the native pipeline to a new index

Info

If adding the effect to MediaPipeline

Parameters

Name	Type	Description
effectId	UInt32	native effect id
oldIndexId	UInt32	index id
newIndexId	UInt32	native index id

Returns

Type	Description
Boolean

`}),e.add({id:1706,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/enumerator/movenext/",title:"MoveNext",section:"ODIN Documentation",description:"",content:`

public bool MoveNext()

Returns

Type	Description
Boolean

`}),e.add({id:1707,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/request/msgidindex/",title:"MsgidIndex",section:"ODIN Documentation",description:" uint32 field (msgid) ",content:`

public const int MsgidIndex = 1

uint32 field (msgid)

Value Type

Type	Description
Int32

`}),e.add({id:1708,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/response/msgidindex/",title:"MsgidIndex",section:"ODIN Documentation",description:" uint32 field (msgid) ",content:`

public const int MsgidIndex = 1

uint32 field (msgid)

Value Type

Type	Description
Int32

`}),e.add({id:1709,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/msgpackmessagetype/",title:"MsgPackMessageType",section:"ODIN Documentation",description:" Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md ",content:`

public enum MsgPackMessageType

Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Properties

Name	Description
Request	Format: [type, msgid, method, params]
Response	Format: [type, msgid, error, result]
Notification	Format: [type, method, params]

`}),e.add({id:1710,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/msgpackreader/",title:"MsgPackReader",section:"ODIN Documentation",description:"",content:`

public struct MsgPackReader

Static Methods

Name	Description
Create
KeyToBytes

Properties

Name	Description
Item[Byte[]]
Item[String]
ArrayLength
Item[Int32]

Public Methods

Name	Description
AsMapEnumerable
AsArrayEnumerable
GetByte
GetSByte
GetShort
GetUShort
GetInt
GetUInt
GetLong
GetULong
GetFloat
GetDouble
GetBool
GetString
GetBinary
GetTimestamp
GetExtension
GetFormatCode
GetFormatName

`}),e.add({id:1711,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/",title:"MsgPackToken",section:"ODIN Documentation",description:" https://github.com/msgpack/msgpack/blob/master/spec.md ",content:`

public static class MsgPackToken

Static Methods

Name	Description
GetSourceType
GetFormatName
IsNegativeFixInt
IsPositiveFixInt
IsFixStr
IsFixMap
IsFixArray
IsByte
IsSByte
IsShort
IsUShort
IsInt
IsUInt
IsLong
IsULong
IsFloat
IsDouble
IsString
IsBinary
IsArray
IsMap
IsExtension
IsNil

Properties

Name	Description
MinPositiveFixInt
MaxPositiveFixInt
MinFixMap
MaxFixMap
MinFixArray
MaxFixArray
MinFixStr
MaxFixStr
Nil
NeverUsed
False
True
Bin8
Bin16
Bin32
Ext8
Ext16
Ext32
Float32
Float64
Uint8
Uint16
Uint32
Uint64
Int8
Int16
Int32
Int64
FixExt1
FixExt2
FixExt4
FixExt8
FixExt16
Str8
Str16
Str32
Array16
Array32
Map16
Map32
MinNegativeFixInt
MaxNegativeFixInt
Type_Unknown
Type_Integer
Type_Nil
Type_Boolean
Type_Float
Type_String
Type_Binary
Type_Array
Type_Map
Type_Extension
ExtTypeCode_Timestamp

`}),e.add({id:1712,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/",title:"MsgPackWriter",section:"ODIN Documentation",description:" Rudimentary Msgpack implementation that will be used for sending RPC to the server. ",content:`

public class MsgPackWriter : IMsgPackWriter, IDisposable

Rudimentary Msgpack implementation that will be used for sending RPC to the server.

Constructors

Name	Description
MsgPackWriter()	Create Writer
MsgPackWriter(Encoding, Boolean)	Create Writer

Static Methods

Name	Description
Create	Create writer with a prefilled stream buffer
WriteByte	Append value with MsgPackToken token to bytes
WriteSByte	Append value with MsgPackToken token to bytes
WriteShort	Append value with MsgPackToken token to bytes
WriteUShort	Append value with MsgPackToken token to bytes
WriteInt	Append value with MsgPackToken token to bytes
WriteUInt	Append value with MsgPackToken token to bytes
WriteLong	Append value with MsgPackToken token to bytes
WriteULong	Append value with MsgPackToken token to bytes
WriteFloat	Append value with MsgPackToken token to bytes
WriteDouble	Append value with MsgPackToken token to bytes
WriteBool	Append fixedbool with either MsgPackToken to bytes
WriteString	Append string value with size based token to bytes
WriteBinary	Append values with size based token to bytes

Properties

Name	Description
Encoding	Used Encoding defaults to UTF8

Public Methods

Name	Description
Clear	Clear stream buffer
Write	Set MsgPackToken based on the unsigend value size
WriteByte	Write value with token MsgPackToken
WriteSByte	Write value with token MsgPackToken
WriteShort	Write value with token MsgPackToken
WriteUShort	Write value with token MsgPackToken
WriteInt	Write value with token MsgPackToken
WriteUInt	Write value with token MsgPackToken
WriteLong	Write value with token MsgPackToken
WriteULong	Write value with token MsgPackToken
WriteFloat	Write value with token MsgPackToken
WriteDouble	Write value with token MsgPackToken
WriteBool	Write fixedbool of either MsgPackToken
WriteString	Write string with writer encoding (default UTF8)
WriteBinary	MessagePack header is big-endian, value binarywriter default little-endian
WriteArrayHeader	MessagePack header is big-endian, value binarywriter default little-endian
WriteMapHeader	MessagePack header is big-endian value binarywriter default little-endian
GetBytes	Get raw bytes from the stream buffer
GetLength	Get raw bytes from the stream buffer
GetBuffer	Get raw bytes from the underlying stream buffer
Append	Append bytes to the stream at the currrent stream position
ToString	String representation of the stream based on encoding (default UTF8)
ToHex	String representation of the stream in hex
Dispose	dispose

`}),e.add({id:1713,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/constructor_0/",title:"MsgPackWriter()",section:"ODIN Documentation",description:"",content:`

public MsgPackWriter()

Create Writer

`}),e.add({id:1714,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/constructor_1/",title:"MsgPackWriter(Encoding, Boolean)",section:"ODIN Documentation",description:"",content:`

public MsgPackWriter(Encoding encoding, bool keep = true)

Create Writer

Parameters

Name	Description
encoding	4Players online endpoints use UTF8
keep	keep or close the binary stream

`}),e.add({id:1715,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/mute/",title:"Mute",section:"ODIN Documentation",description:" The Unity AudioSource mute property ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Mute { get; set; }

The Unity AudioSource mute property

Info

Sets volume to 0 or restore original volume

Value Type

Type	Description
Boolean

`}),e.add({id:1716,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/mute/",title:"Mute",section:"ODIN Documentation",description:" The Unity AudioSource mute property ",content:`

public bool Mute { get; set; }

The Unity AudioSource mute property

Info

Sets volume to 0 or restore original volume

Value Type

Type	Description
Boolean

`}),e.add({id:1717,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/mute/",title:"Mute",section:"ODIN Documentation",description:" The Unity AudioSource mute property ",content:`

public bool Mute { get; set; }

The Unity AudioSource mute property

Info

Sets volume to 0 or restore original volume

Value Type

Type	Description
Boolean

`}),e.add({id:1718,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/mute/",title:"Mute",section:"ODIN Documentation",description:" The Unity AudioSource mute property ",content:`

public bool Mute { get; set; }

The Unity AudioSource mute property

Info

Sets volume to 0 or restore original volume

Value Type

Type	Description
Boolean

`}),e.add({id:1719,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/mute/",title:"Mute",section:"ODIN Documentation",description:" The Unity AudioSource mute property ",content:`

public bool Mute { get; set; }

The Unity AudioSource mute property

Info

Sets volume to 0 or restore original volume

Value Type

Type	Description
Boolean

`}),e.add({id:1720,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/muteroommicrophone/",title:"MuteRoomMicrophone",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MuteRoomMicrophone(Room room, bool mute)

Request SetMicrophoneMute(System to mute by room

Info

Always false if there is no microphone or the room was not joined

Parameters

Name	Type	Description
room	Room
mute	Boolean	true to mute and false to unmute

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:1721,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/mutestream/",title:"MuteStream",section:"ODIN Documentation",description:" The Odin PlaybackStream underlying media stream calls ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool MuteStream { get; set; }

The Odin PlaybackStream underlying media stream calls

Info

on true ignores stream calls

Value Type

Type	Description
Boolean

`}),e.add({id:1722,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonestream/mutestream/",title:"MuteStream",section:"ODIN Documentation",description:"",content:`

public void MuteStream(bool mute)

Parameters

Name	Type	Description
mute	Boolean

`}),e.add({id:1723,href:"https://www.4players.io/odin/sdk/unity/classes/microphonestream/mutestream/",title:"MuteStream",section:"ODIN Documentation",description:"",content:`

public void MuteStream(bool mute)

Parameters

Name	Type	Description
mute	Boolean

`}),e.add({id:1724,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string Name

Room name

Value Type

Type	Description
String

`}),e.add({id:1725,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

public string Name

Room name

Value Type

Type	Description
String

`}),e.add({id:1726,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

public string Name

Room name

Value Type

Type	Description
String

`}),e.add({id:1727,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

public string Name

Room name

Value Type

Type	Description
String

`}),e.add({id:1728,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

public string Name { get; }

Room name

Value Type

Type	Description
String

`}),e.add({id:1729,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcresult/name/",title:"Name",section:"ODIN Documentation",description:" method ",content:`

public string Name { get; }

method

Value Type

Type	Description
String

`}),e.add({id:1730,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/name/",title:"Name",section:"ODIN Documentation",description:" Room name ",content:`

public string Name

Room name

Value Type

Type	Description
String

`}),e.add({id:1731,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1732,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1733,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1734,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1735,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1736,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/nativebinary/",title:"NativeBinary",section:"ODIN Documentation",description:" Location of the native ODIN runtime binary ",content:`

public static string NativeBinary { get; }

Location of the native ODIN runtime binary

Value Type

Type	Description
String

`}),e.add({id:1737,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Type	Description
OdinVersion	String	ODIN_VERSION

`}),e.add({id:1738,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Type	Description
OdinVersion	String	ODIN_VERSION
BlockSamplerate	UInt32	Block_SAMPLE_RATE

`}),e.add({id:1739,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Type	Description
OdinVersion	String	ODIN_VERSION

`}),e.add({id:1740,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Description
OdinVersion	ODIN_VERSION
BlockSamplerate	Block_SAMPLE_RATE

`}),e.add({id:1741,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Description
OdinVersion	ODIN_VERSION

`}),e.add({id:1742,href:"https://www.4players.io/odin/sdk/unity/classes/nativebindings/",title:"NativeBindings",section:"ODIN Documentation",description:" C# bindings for the native ODIN runtime ",content:`

public static class NativeBindings

C# bindings for the native ODIN runtime

Properties

Name	Description
OdinVersion	ODIN_VERSION
BlockSamplerate	Block_SAMPLE_RATE

`}),e.add({id:1743,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/neverused/",title:"NeverUsed",section:"ODIN Documentation",description:"",content:`

public const byte NeverUsed = 193

Value Type

Type	Description
Byte

`}),e.add({id:1744,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinconnectionstatechangedeventpayload/newstate/",title:"newState",section:"ODIN Documentation",description:"Current state of the connection.",content:`

OdinConnectionState

Current state of the connection.

Value Type

Type	Description
Byte

`}),e.add({id:1746,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/noise_suppression/",title:"noise_suppression",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinNoiseSuppression noise_suppression

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1747,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/noisesuppression/",title:"NoiseSuppression",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinNoiseSuppression NoiseSuppression

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1748,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/noisesuppressionlevel/",title:"noiseSuppressionLevel",section:"ODIN Documentation",description:"Set the aggressiveness of the suppression",content:`

public noiseSuppressionLevel: OdinNoiseSuppressionLevel

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1750,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Turns noise suppression on and off ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Turns noise suppression on and off

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1751,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Set the aggressiveness of the suppression ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1752,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public static NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1753,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Turns noise suppression on and off ",content:`

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Turns noise suppression on and off

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1754,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Set the aggressiveness of the suppression ",content:`

public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1755,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public static NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1756,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Turns noise suppression on and off ",content:`

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Turns noise suppression on and off

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1757,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Set the aggressiveness of the suppression ",content:`

public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1758,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public static NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1759,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Turns noise suppression on and off ",content:`

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Turns noise suppression on and off

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1760,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Set the aggressiveness of the suppression ",content:`

public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1761,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public OdinNoiseSuppression NoiseSuppressionLevel { get; set; }

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1762,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public static NativeBindings.OdinNoiseSuppression NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1763,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Idicates the level of noise suppression ApmConfig setting by default ",content:`

public static NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Idicates the level of noise suppression ApmConfig setting by default

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1764,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Turns noise suppression on and off ",content:`

public NativeBindings.OdinNoiseSuppressionLevel NoiseSuppressionLevel

Turns noise suppression on and off

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1765,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/noisesuppressionlevel/",title:"NoiseSuppressionLevel",section:"ODIN Documentation",description:" Set the aggressiveness of the suppression ",content:`

public OdinNoiseSuppressionLevel NoiseSuppressionLevel { get; set; }

Set the aggressiveness of the suppression

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1766,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/none/",title:"None",section:"ODIN Documentation",description:" None ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

None = 0

None

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1767,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/none/",title:"None",section:"ODIN Documentation",description:" None ",content:`

None = 0

None

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1768,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/none/",title:"None",section:"ODIN Documentation",description:" None ",content:`

None = 0

None

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1769,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/none/",title:"None",section:"ODIN Documentation",description:" None ",content:`

None = 0

None

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1770,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/none/",title:"None",section:"ODIN Documentation",description:" None ",content:`

None = 0

None

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:1771,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/notification/",title:"Notification",section:"ODIN Documentation",description:" Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md ",content:`

public static class Notification

Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Properties

Name	Description
MethodIndex	string field (method)
ParamsIndex	params field (params)

`}),e.add({id:1772,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/msgpackmessagetype/notification/",title:"Notification",section:"ODIN Documentation",description:" Format: [type, method, params] ",content:`

Notification = 2

Format: [type, method, params]

Value Type

Type	Description
MsgPackMessageType

`}),e.add({id:1773,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/objectposition/",title:"ObjectPosition",section:"ODIN Documentation",description:" Original source ",content:`

public Vector3 ObjectPosition

Original source

Value Type

Type	Description
Vector3

`}),e.add({id:1776,href:"https://www.4players.io/odin/offline-doc-manual/",title:"ODIN Unity Offline Documentation",section:"ODIN Documentation",description:"",content:`

Welcome to 4Players ODIN, our next-generation, real-time, zero maintenance, highest quality voice solution deeply integrated into Unity. Thank you very much for your interest in ODIN and for the time you’ll spend figuring out if ODIN is the best solution for your game. We are sure it is, and therefore we have made our best to provide extensive documentation to get you started quickly.

In this document we provide basic info to the ODIN components and a basic introduction. We provide links to our extensive API reference documentation. We also suggest that you follow the getting started guide either in the provided getting-started.pdf file or on our online documentation.

Introduction
Components

Introduction

ODIN is a standalone client server architecture. 4Players hosts the servers, handles the network and all the audio processing that is required for great voice communication. From your perspective, ODIN is a pur client integration, you don’t need to do any server side processing or maintenance.

graph BT
  subgraph ODIN Server
    OR2[Odin Room]
    OR[Odin Room]    
  end
  subgraph Gameserver
    GS[Game Server]
  end
  subgraph Game
    ClientA[Player A] --> OR[ODIN Room]
    ClientB[Player B] --> OR[ODIN Room] 
    ClientB[Player B] --> GS[Game Server]   
    ClientC[Player C] --> GS[Game Server]
    ClientC[Player C] --> OR[ODIN Room] 
    ClientD[Player D] --> GS[Game Server]
  end
  subgraph Lobby
    ClientE[Players E] --> OR2[ODIN Room]
    ClientF[Players F] --> OR2[ODIN Room]
  end

This graph outlines how ODIN works in a multiplayer environment. You build the client application (i.e. the game) and the server component (game server) as usual. Once ODIN is integrated into your game, the players device will connect to the game server as usual, but in addition to that to ODIN servers that route all voice packets to all other players joined to the same ODIN room. Players may choose not to use voice chat. Those players will not connect to ODIN and will not be able to listen or talk to other players (like Player D). On the other side, other players might only join the voice server, without playing - for example if they are in the lobby, or the angry mum yelling that the player should stop playing and doing his homework (player A).

You can integrate ODIN in single player games with a community element, virtual or augmented reality based video conferencing solutions, the meta verse, virtual homeschooling and training applications and of course multiplayer games (peer to peer or dedicated servers) from simple shooters to massive multiplayer online games with thousands of players in the same room.

As ODIN supports cross play you can even connect a mobile application or website directly with players in the game. A battle net like launcher application based on Electron where players can meet and chat and directly start a shared game with automatic hand-over.

The possibilities are endless, and you don’t need to be an audio or server expert! We have compiled a couple of use-cases if you are still unsure if ODIN fits for needs.

Requirements

Supported platforms

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Components

The ODIN SDK for Unity comes with four components. OdinEditorConfig is the place for all ODIN specific settings. Here you’ll setup sample rate, event callbacks and more. The OdinHandler is the singleton class that is persistent throughout the lifecycle of your game ( uses DontDestroyOnLoad) and is used to join rooms and exposes callback functions and delegates that allow you to customize the experience. Next, MicrophoneReader is the component that handles the devices audio devices (microphones), captures audio and sends them to ODIN servers. Last but not least, the PlaybackComponent is the “speaker” in the system. It’s basically a standard Unity AudioSource that does play the microphone of the connected player right in the Unity scene.

In a nutshell, the MicrophoneReader component is the mic, the PlaybackComponent is the speaker playing in real-time what is recorded by the connected mic and the OdinHandler manages these connections and their lifecycle using settings and event callbacks stored in the OdinEditorConfig.

Odin Editor Config

The OdinEditorConfig component class allows you to setup various aspects of ODIN within your game. If you follow our guide on settings up ODIN within your game, you should see this in your Unity inspector if the Odin Manager Game Object is selected. Odin Editor Config is one of three parts of the Odin Manager Game Object.

Client Authentication

Use the first section Client Authentication to set up your access key and user data. This is for development purposes only as you should not expose your access key in the production version of your game. You should rather request the access key from a secure server backend. We have compiled a document explaining access keys and how to generate and use/store them: Access Keys in ODIN.

Properties

Property	Description
Access Key	The access key that shall be used to generate access tokens for individual users. Read here on how to generate it.
Gateway URL	The base URL of the gateway. If you are using our hosted solution, leave it as is, otherwise if you are hosting yourself you need to adjust the URL
Manage Access	You can generate an access token for testing purposes right in the Unity editor for up to 25 users by pressing this button. See below for more details.
Client ID	The client id of your application. Use the Player Settings of Unity to set this value
User Data	This is the default user data that will be used for each player (if nothing is provided by you when joining the room)

More info on the user data can be found in the user data guide. A sample of what you can do with user data can be found in one of our integration guides.

Create access token

You don’t need to talk to anyone at 4Players or subscribe to our tiers to test ODIN. After clicking on the Manage Access button, this window will popup. Click on the “Generate Access Key” button to create an access key that allows you to test ODIN for up to 25 players.

Warning

You don’t need a (paid) tier for testing and development purposes. But you may not go into production with access keys generated this way. There is no guarantee that they will work for a longer period of time and there is also not any support.

Capture & Playback

Use this section to setup your audio settings.

Properties

Property	Description
Capture Sample Rate	The sample rate that will be captured from the players MicrophoneReader
Capture Channels	Choose if MicrophoneReader should capture `Mono` or `Stereo` channels. In most cases, `Mono` is enough.
Playback Sample Rate	The sample rate that the server will use. If it does not match to the players sample rate the server will downgrade accordingly
Playback Channels	Choose if the server handles `Mono` or `Stereo` samples

Room Settings

ODIN provides latest audio technology based on machine learning and other advanced techniques to make sure, that audio quality is excellent for your players. It’s important, that the game experience and immersion is not destroyed by noise like cars, airplanes, kids screaming or just the noise produced by cheap microphones.

Our mission is to provide the best audio experience for each of your players. Some of these features can be enabled or disabled or adjusted directly in the Unity editor. You’ll find these settings in this section.

Event Listeners

Warning

From Unity SDK version 0.5.0 the event handler settings have been moved to the Odin Handler class.

ODIN Handler

Let’s have a look at the settings exposed by the next component of a typical ODIN Manager Game Object: Odin Handler .

Odin Handler

The OdinHandler component class is the global manager (singleton) for Odin inside your game. You can use it to connect your own callbacks.

Info

ODIN uses DontDestroyOnLoad in this class to make sure that this component and game object survives scene changes.

Microphone

The first option provided in the Odin Handler Inspector is the microphone setting:

Drag & Drop the Game Object within your scene that has the Microphone Reader component attached. If you have created a standard ODIN Manager Game Object by following our manual then this will be the same game object that the Odin Handler is attached to.

Warning

If you put the Microphone Reader component on a different game object than the Odin Handler you need to make sure that the other game object also uses DontDestroyOnLoad to survice scene changes. Otherwise, your players will not be able to talk to other players as their microphone game object got removed. Of course, you can also use that as a feature to disable microphone input in specific scenes. But you need to be careful with lifecycle management of your game objects if you separate Odin Handler and Microphone Reader into different game objects.

Mixer Settings

Another set of options is playback mixer settings.

Sometimes you want to apply some audio effects to voice, like cell broadcast interferences or noise. Create a Unity AudioMixerGroup or AudioMixer and assign it to one of these options.

Setting	Description
Playback Mixer	Create a Unity AudioMixer asset and drag it into this field.
Playback Mixer Group	Create a Unity AudioMixerGroup asset and drag it into this field.

Playback Creation

In this section, you can activate some SDK automations, that make your life easier. In some special cases you might take control of various aspects yourself, but for most use-cases you can make use of these automations.

Info

Please note: You should only select one of these checkboxes. We’ll change that to a drop down field in the next version of the SDK.

If both settings are unchecked you’ll need to handle the events like OnMediaAdded yourself and you’ll also need to create audio pipeline elements yourself. See the source-code of the SDK on how to do that.

Playback auto creation

If you check this box, the ODIN SDK will automatically create an AudioSource and link that to the ODIN server for you and will handle the lifetime for you.

In addition to that, and that distinguishes this setting to Manual Positional Audio is that the PlaybackComponent will be automatically attached to the GameObject with the OdinHandler attached.

This is the easiest way to implement a simple “video conferencing” like use case where you don’t have positional audio or specific teams.

Info

As all users voice is attached to one GameObject automatically you cannot implement any form of 3D audio this way. If you want to have 3D audio, you need to deactivate this setting and activate Manual Positional Audio instead (see description below).

Manual Positional Audio

If you check this box (and uncheck the other setting) ODIN will automatically create an AudioSource for you and link that to the ODIN server and handles the lifetime of it.

However, you are responsible to attach the PlaybackComponent to a GameObject representing the player (in space) and thus allowing you to implement 3D audio with ease.

Check out these guides on how to get notified of the SDK once an audio stream has been prepared and how to handle the event:

Getting Started with Unity: Create a simple Unity project and add ODIN to it. Shows the basic workflow and basic event handling.
Unity with Mirror Networking: Shows how to implement ODIN into a multiplayer game built with mirror networking. Create a simple multi-player game and add ODIN to it in under 20 minutes.

What you basically have to do is to listen on the OnCreatedMediaObject and OnDeleteMediaObject events of the OdinHandler instance like this:

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(OnDeleteMediaObject);
}

ODIN will call these events once a user joined the room and added a media object or removed it (i.e. muted their audio). Please note, that users can join a room without adding their own media stream (i.e. spectators).

You’ll need to call AddPlaybackComponent method which will create a PlaybackComponent and attach it to the Game Object that you provide. Of course, you’ll need to have some logic to find the correct player GameObject for the ODIN. Every ODIN user (peer) has it’s own user data which you can use to link your GameObjects to ODIN. The best place to learn how to do that is our guide Unity with Mirror Networking.

Here is a simple example on how to handle the event. More examples can be found in the reference documentation of PlaybackComponent , the OnMediaAdded event and the guides linked above.

private void OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Create or find a player object in the scene
    var peerContainer = CreateOrFindGameObject(peerId, roomName);

    // Create PlaybackComponent and add to the players GameObject
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Set spatialBlend to 1.0f to activate fill 3D audio and adjust some 3D audio settings
    // This is basic Unity stuff. PlaybackSource is an AudioSource object. See Unity documentation for more info 
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

Events

ODIN has a couple of events that allows you to react on things that happen within the ODIN runtime. Use these settings to connect your own game objects and scripts to ODIN. You can also do that in code if you like. Have a look at the OdinHandler class for more infos about that.

These are standard Unity events. Click on the + button to add a listener and than drag & drop the game object that has your handler script attached exposing public callbacks for the events you want to listen to.

Read more about the events available in our Scripting documentation:

Room events

These events are sent if anything happens with the rooms the player has joined. Use the JoinRoom method of the OdinHandler class to connect the player to one or more rooms. These events will then trigger and allow you to react on these in your own scripts by attaching callbacks.

Event Type	Description
Room Join	Called before a player joins a room: OnRoomJoin
Room Joined	Called after a player joined a room: OnRoomJoined
Room Leave	Called before a player leaves a room: OnRoomLeave
Room Left	Called after a player left a room: OnRoomLeft

Peer events

Whenever something happens in the room the player is connected to, i.e. another player joins the room or updates his user data, these events are triggered and allow you to react on those in your own scripts.

Property	Description
Peer Joined	Called when another player joined the room: OnPeerJoined
Peer Left	Called when another player left the room: OnPeerLeft
Peer Updated	When the user data of a peer changes, this callback is called: OnPeerUserDataChanged

Warning

It’s important to understand the difference between a peer and a media stream. In ODIN it’s possible to join a room as a listener but not sending media into the room. A typical use case for this is a spectator or in a podcast, only the podcaster is able to say something while the others are just listening.

It’s the same in ODIN: If a player connects a room, the Peer Joined event is triggered. Now, the player listens to the audio streams in this room. If the Odin Handler of the other player has a Microphone Reader

attached and is active and recording, a Media Added event will be triggered once the audio stream of the other player notifying all other peers, that there is an additional audio stream they need to listen to now.

If the other player disables his microphone, a Media Removed event is triggered and all other peers will stop listening on this audio source.

Media events

When media streams are added or removed, you’ll receive these events.

Property	Description
Media Added	Called when the microphone stream of another user is joining the room: OnMediaAdded
Media State Changed	Called when the medias state changed: `OnMediaActiveStateChanged`
Media Removed	When one of the peers removes his microphone stream of the room, this callback is triggered: OnMediaRemoved

Microphone Reader settings

In a typical ODIN Manager Game Object a Microphone Reader component is attached which handles the players microphone and audio input. Let’s step through these settings here: Microphone Reader .

Microphone Reader

The MicrophoneReader component class starts capturing audio input from attached microphones and sends audio packets to the ODIN runtime which distributes them to the other peers joined to the same room.

This component is typically attached to the same game object as the Odin Handler . If you put this object on a different game object, make sure you attach it to the Microphone setting of the Odin Handler component.

Basic Settings

These are the settings exposed in the Unity Inspector for this component:

Properties

Property	Description
Redirect captured audio	Automatically send all captured audio data to all rooms this player joined. If you want more control, disable this setting.
Continue Recording	Indicates whether the recording should continue recording if AudioClipLength is reached, and wrap around and record from the beginning of the AudioClip.

Mic Audio-Clip Settings

In this section you can adjust various settings relevant for Audio Clip Management. In Unity all audio is stored in an AudioClip . As Unity does not support real-time audio streams, ODIN just modifies an Audio Clip and overwrites it over and over again once it came to an end.

Use these settings to adjust these behaviors.

Properties

Property	Description
Audio Clip Length	The length of the audio clip. If `Continue Recording` is enabled, this will be overwritten everytime it’s full.
Override Sample Rate	Activate this setting to specify a different sample rate than globally set in the Odin Editor Config
Sample Rate	Only visible of Override Sample Rate is active. Set the sample rate that you want to have for this microphone. >}}
Autostart Microphone	If enabled, the microphone will immediately start listening and sending audio data to ODIN. If disabled, you need to call StartListen manually.

Playback Component

This component is automatically created and attached during runtime when you call the method AddPlaybackComponent on the OdinHandler singleton in your scene.

Do not add this component manually in the editor.

More info on this topic can be found here:

OdinHandler reference documentation
OnMediaAdded event and how to use it
Unity Multiplayer Game Integration Guide

`}),e.add({id:1780,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odineffecttype/odin_effect_type_apm/",title:"ODIN_EFFECT_TYPE_APM",section:"ODIN Documentation",description:"",content:`

ODIN_EFFECT_TYPE_APM = 1

Value Type

Type	Description
OdinEffectType

`}),e.add({id:1781,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odineffecttype/odin_effect_type_custom/",title:"ODIN_EFFECT_TYPE_CUSTOM",section:"ODIN Documentation",description:"",content:`

ODIN_EFFECT_TYPE_CUSTOM = 2

Value Type

Type	Description
OdinEffectType

`}),e.add({id:1782,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odineffecttype/odin_effect_type_vad/",title:"ODIN_EFFECT_TYPE_VAD",section:"ODIN Documentation",description:"",content:`

ODIN_EFFECT_TYPE_VAD = 0

Value Type

Type	Description
OdinEffectType

`}),e.add({id:1783,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_apm_error/",title:"ODIN_ERROR_APM_ERROR",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_APM_ERROR = -1

Value Type

Type	Description
OdinError

`}),e.add({id:1784,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_argument_invalid_handle/",title:"ODIN_ERROR_ARGUMENT_INVALID_HANDLE",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_ARGUMENT_INVALID_HANDLE = -3

Value Type

Type	Description
OdinError

`}),e.add({id:1785,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_argument_invalid_id/",title:"ODIN_ERROR_ARGUMENT_INVALID_ID",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_ARGUMENT_INVALID_ID = -5

Value Type

Type	Description
OdinError

`}),e.add({id:1786,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_argument_invalid_string/",title:"ODIN_ERROR_ARGUMENT_INVALID_STRING",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_ARGUMENT_INVALID_STRING = -2

Value Type

Type	Description
OdinError

`}),e.add({id:1787,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_argument_null/",title:"ODIN_ERROR_ARGUMENT_NULL",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_ARGUMENT_NULL = -4

Value Type

Type	Description
OdinError

`}),e.add({id:1788,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_argument_out_of_bounds/",title:"ODIN_ERROR_ARGUMENT_OUT_OF_BOUNDS",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_ARGUMENT_OUT_OF_BOUNDS = -6

Value Type

Type	Description
OdinError

`}),e.add({id:1789,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_closed/",title:"ODIN_ERROR_CLOSED",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_CLOSED = -112

Value Type

Type	Description
OdinError

`}),e.add({id:1790,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_decoder_error/",title:"ODIN_ERROR_DECODER_ERROR",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_DECODER_ERROR = -108

Value Type

Type	Description
OdinError

`}),e.add({id:1791,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_end_argument_errors/",title:"ODIN_ERROR_END_ARGUMENT_ERRORS",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_END_ARGUMENT_ERRORS = -7

Value Type

Type	Description
OdinError

`}),e.add({id:1792,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_initialization_failed/",title:"ODIN_ERROR_INITIALIZATION_FAILED",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INITIALIZATION_FAILED = -101

Value Type

Type	Description
OdinError

`}),e.add({id:1793,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_invalid_access_key/",title:"ODIN_ERROR_INVALID_ACCESS_KEY",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INVALID_ACCESS_KEY = -102

Value Type

Type	Description
OdinError

`}),e.add({id:1794,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_invalid_gateway_uri/",title:"ODIN_ERROR_INVALID_GATEWAY_URI",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INVALID_GATEWAY_URI = -103

Value Type

Type	Description
OdinError

`}),e.add({id:1795,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_invalid_state/",title:"ODIN_ERROR_INVALID_STATE",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INVALID_STATE = -104

Value Type

Type	Description
OdinError

`}),e.add({id:1796,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_invalid_token/",title:"ODIN_ERROR_INVALID_TOKEN",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INVALID_TOKEN = -105

Value Type

Type	Description
OdinError

`}),e.add({id:1797,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_invalid_version/",title:"ODIN_ERROR_INVALID_VERSION",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_INVALID_VERSION = -106

Value Type

Type	Description
OdinError

`}),e.add({id:1798,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_no_data/",title:"ODIN_ERROR_NO_DATA",section:"ODIN Documentation",description:" Successful status code equivalent with "end of data" ",content:`

ODIN_ERROR_NO_DATA = 1

Successful status code equivalent with "end of data"

Value Type

Type	Description
OdinError

`}),e.add({id:1799,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_opus_error/",title:"ODIN_ERROR_OPUS_ERROR",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_OPUS_ERROR = -107

Value Type

Type	Description
OdinError

`}),e.add({id:1800,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_success/",title:"ODIN_ERROR_SUCCESS",section:"ODIN Documentation",description:" Successful status code OK ",content:`

ODIN_ERROR_SUCCESS = 0

Successful status code OK

Value Type

Type	Description
OdinError

`}),e.add({id:1801,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_token_room_rejected/",title:"ODIN_ERROR_TOKEN_ROOM_REJECTED",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_TOKEN_ROOM_REJECTED = -109

Value Type

Type	Description
OdinError

`}),e.add({id:1802,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_unsupported_effect/",title:"ODIN_ERROR_UNSUPPORTED_EFFECT",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_UNSUPPORTED_EFFECT = -111

Value Type

Type	Description
OdinError

`}),e.add({id:1803,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/odin_error_unsupported_version/",title:"ODIN_ERROR_UNSUPPORTED_VERSION",section:"ODIN Documentation",description:"",content:`

ODIN_ERROR_UNSUPPORTED_VERSION = -110

Value Type

Type	Description
OdinError

`}),e.add({id:1804,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/odin_noise_suppression_high/",title:"ODIN_NOISE_SUPPRESSION_HIGH",section:"ODIN Documentation",description:" Use high suppression (18 dB) ",content:`

ODIN_NOISE_SUPPRESSION_HIGH = 3

Use high suppression (18 dB)

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1805,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/odin_noise_suppression_low/",title:"ODIN_NOISE_SUPPRESSION_LOW",section:"ODIN Documentation",description:" Use low suppression (6 dB) ",content:`

ODIN_NOISE_SUPPRESSION_LOW = 1

Use low suppression (6 dB)

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1806,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/odin_noise_suppression_moderate/",title:"ODIN_NOISE_SUPPRESSION_MODERATE",section:"ODIN Documentation",description:" Use moderate suppression (12 dB) ",content:`

ODIN_NOISE_SUPPRESSION_MODERATE = 2

Use moderate suppression (12 dB)

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1807,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/odin_noise_suppression_none/",title:"ODIN_NOISE_SUPPRESSION_NONE",section:"ODIN Documentation",description:" Noise suppression is disabled ",content:`

ODIN_NOISE_SUPPRESSION_NONE = 0

Noise suppression is disabled

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1808,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/odin_noise_suppression_very_high/",title:"ODIN_NOISE_SUPPRESSION_VERY_HIGH",section:"ODIN Documentation",description:" Use very high suppression (21 dB) ",content:`

ODIN_NOISE_SUPPRESSION_VERY_HIGH = 4

Use very high suppression (21 dB)

Value Type

Type	Description
OdinNoiseSuppression

`}),e.add({id:1809,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/",title:"OdinApmComponent",section:"ODIN Documentation",description:" AudioProcessingModule component for This class provides configuration for the native implemented audio processing. The supported processor/filter are applicable to which must be set. ",content:`

public class OdinApmComponent : MonoBehaviour, IOdinEffect

AudioProcessingModule component for Media

This class provides configuration for the native implemented audio processing. The supported processor/filter are applicable to Media which must be set.

Properties

Name	Description
Media
Effect
IsCreated
EchoCanceller
HighPassFilter
PreAmplifier
NoiseSuppression
TransientSuppressor
GainController

Public Methods

Name	Description
UpdateConfig
ResetEffect
GetMedia
GetEffect

`}),e.add({id:1810,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/",title:"OdinApmConfig",section:"ODIN Documentation",description:"",content:`

public struct OdinApmConfig

Properties

Name	Description
echo_canceller
high_pass_filter
pre_amplifier
noise_suppression
transient_suppressor
gain_controller

`}),e.add({id:1811,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/",title:"OdinAPMSettings",section:"ODIN Documentation",description:"",content:`

export interface OdinAPMSettings

Properties

Name	Type	Description
echoCanceller	boolean	Enable or disable echo cancellation
gainController	boolean	Enable or disable the gain controller
highPassFilter	boolean	Enable or disable high pass filtering
noiseSuppressionLevel	OdinNoiseSuppressionLevel	Set the aggressiveness of the suppression
preAmplifier	boolean	Enable or disable the pre amplifier
transientSuppressor	boolean	Enable or disable the transient suppressor
voiceActivityDetection	boolean	Enables or disables voice activity detection (VAD)
voiceActivityDetectionAttackProbability	number	Voice probability value when the VAD should engage
voiceActivityDetectionReleaseProbability	number	Voice probability value when the VAD should disengage
volumeGate	boolean	Enables or disables the input volume gate
volumeGateAttackLoudness	number	Root-mean-square power (dBFS) when the volume gate should engage
volumeGateReleaseLoudness	number	Root-mean-square power (dBFS) when the volume gate should disengage

`}),e.add({id:1812,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/",title:"OdinAudioData",section:"ODIN Documentation",description:"",content:`

public class OdinAudioData

Properties

Name	Description
samples	float[]
samples_count
is_silent

Public Methods

Name	Description
CopyFrame
SetFrame

`}),e.add({id:1813,href:"https://www.4players.io/odin/sdk/nodejs/types/odinaudiodatareceivedevent/",title:"OdinAudioDataReceivedEvent",section:"ODIN Documentation",description:"",content:`

type OdinAudioDataReceivedEvent = (event: OdinAudioDataReceivedEventPayload)

Parameters

Name	Type	Description
event	OdinAudioDataReceivedEventPayload

`}),e.add({id:1814,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinaudiodatareceivedeventpayload/",title:"OdinAudioDataReceivedEventPayload",section:"ODIN Documentation",description:"The payload for the AudioDataReceived event.",content:`

export interface OdinAudioDataReceivedEventPayload

The payload for the AudioDataReceived event.

Properties

Name	Type	Description
mediaId	number	The ID of the media that sent the audio data.
peerId	number	The ID of the peer that sent the audio data.
samples16	Uint8Array	The audio data received from the peer as 16-bit PCM samples ranging from -32768 to 32767 as a byte array. Use `const samplesArray = new Int16Array(samples16.buffer)` to get an actual array
samples32	Uint8Array	The audio data received from the peer as 32-bit PCM samples ranging from -1 to 1. Use `const floats = new Float32Array(samples32.buffer)` to get an actual array

`}),e.add({id:1815,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediacallbackmarshal/",title:"OdinAudioMediaCallbackMarshal",section:"ODIN Documentation",description:"",content:`

public class OdinAudioMediaCallbackMarshal : ICustomMarshaler

Static Methods

Name	Description
GetInstance

Public Methods

Name	Description
MarshalManagedToNative
MarshalNativeToManaged
CleanUpNativeData
CleanUpManagedData
GetNativeDataSize

`}),e.add({id:1816,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiomediamarshal/",title:"OdinAudioMediaMarshal",section:"ODIN Documentation",description:"",content:`

public class OdinAudioMediaMarshal : ICustomMarshaler

Static Methods

Name	Description
GetInstance

Public Methods

Name	Description
MarshalManagedToNative
MarshalNativeToManaged
CleanUpNativeData
CleanUpManagedData
GetNativeDataSize

`}),e.add({id:1817,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/",title:"OdinAudioReader",section:"ODIN Documentation",description:" Handles audioclip input data and sends input to ODIN This convenient class gathers input audio data from Unity to pass the data with event to other components. ",content:`

public class OdinAudioReader : MonoBehaviour

Handles audioclip input data and sends input to ODIN

This convenient class gathers input audio data from Unity to pass the data with OdinAudioReader event to other components.

Properties

Name	Description
RedirectInputAudio	Skips registered PushAudio
SilenceInputAudio	Zero out the event audio buffer.
ContinueRecording
InputClip
CustomInputVolumeScale
InputVolumeScale
OnAudioData

`}),e.add({id:1818,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinaudioreadonlydata/",title:"OdinAudioReadOnlyData",section:"ODIN Documentation",description:"",content:`

public struct OdinAudioReadOnlyData

Properties

Name	Description
samples	float[]
samples_count
is_silent

`}),e.add({id:1819,href:"https://www.4players.io/odin/sdk/web/types/odinaudiostatsevent/",title:"OdinAudioStatsEvent",section:"ODIN Documentation",description:"",content:`

type OdinAudioStatsEvent = (event: IOdinEvent<IOdinAudioStatsEventPayload>)

Discussion

The OdinAudioStatsEvent event is emitted on OdinRoom instances every second and provides access to internal Opus encoder/decoder statistics, which can be used for diagnostic purposes.

Events are inheriting from IOdinEvent and provide an object described by IOdinAudioStatsEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents

Example

OdinAudioStatsEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Listen for audio stats updates
  odinRoom.addEventListener('AudioStats', (event) => {
    console.log('Audio stats received:', event.payload);
  });

  // Join the room
  odinRoom.join();

  // Create a new audio stream for our default capture device and append it to the room
  navigator.mediaDevices.getUserMedia({ audio: true }).then((mediaStream) => {
    odinRoom.createMedia(mediaStream);
  });
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinAudioStatsEventPayload>

`}),e.add({id:1820,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinaudiostreamstats/",title:"OdinAudioStreamStats",section:"ODIN Documentation",description:" Audio stream statistics. ",content:`

public struct OdinAudioStreamStats

Audio stream statistics.

Properties

Name	Type	Description
jitter_packets_processed	UInt32	The number of packets processed by the medias jitter buffer.
jitter_packets_dropped_too_early	UInt32	The number of packets dropped because they seemed to arrive too early.
jitter_packets_dropped_too_late	UInt32	The number of packets processed because they seemed to arrive too late.
jitter_packets_lost	UInt32	The number of packets marked as lost during transmission.

`}),e.add({id:1821,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinaudiostreamstats/",title:"OdinAudioStreamStats",section:"ODIN Documentation",description:" Audio stream statistics. ",content:`

public struct OdinAudioStreamStats

Audio stream statistics.

Properties

Name	Description
jitter_packets_processed	The number of packets processed by the medias jitter buffer.
jitter_packets_dropped_too_early	The number of packets dropped because they seemed to arrive too early.
jitter_packets_dropped_too_late	The number of packets processed because they seemed to arrive too late.
jitter_packets_lost	The number of packets marked as lost during transmission.

`}),e.add({id:1822,href:"https://www.4players.io/odin/sdk/unity/structs/odinaudiostreamstats/",title:"OdinAudioStreamStats",section:"ODIN Documentation",description:" Audio stream statistics. ",content:`

public struct OdinAudioStreamStats

Audio stream statistics.

Properties

Name	Description
jitter_packets_processed	The number of packets processed by the medias jitter buffer.
jitter_packets_dropped_too_early	The number of packets dropped because they seemed to arrive too early.
jitter_packets_dropped_too_late	The number of packets processed because they seemed to arrive too late.
jitter_packets_lost	The number of packets marked as lost during transmission.

`}),e.add({id:1823,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinBanner : MonoBehaviour

`}),e.add({id:1824,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

public class OdinBanner : MonoBehaviour

`}),e.add({id:1825,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

public class OdinBanner : MonoBehaviour

`}),e.add({id:1826,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

public class OdinBanner : MonoBehaviour

`}),e.add({id:1827,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

public class OdinBanner : MonoBehaviour

`}),e.add({id:1828,href:"https://www.4players.io/odin/sdk/unity/classes/odinbanner/",title:"OdinBanner",section:"ODIN Documentation",description:"",content:`

public class OdinBanner : MonoBehaviour

`}),e.add({id:1829,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/",title:"OdinCallbackAudioData",section:"ODIN Documentation",description:"",content:`

public class OdinCallbackAudioData

Constructors

Name	Description
OdinCallbackAudioData(IntPtr, IntPtr, UInt32)

Properties

Name	Description
samples
samples_count
is_silent

Public Methods

Name	Description
ResetBuffer
FlushFrameBuffer
FlushSilentFlag
CopyFrom
CopyTo
Flush

`}),e.add({id:1830,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/constructor_0/",title:"OdinCallbackAudioData(IntPtr, IntPtr, UInt32)",section:"ODIN Documentation",description:"",content:`

public OdinCallbackAudioData(IntPtr nativePtr, IntPtr samplesPtr, uint samplesCount)

Parameters

Name	Description
nativePtr
samplesPtr
samplesCount

`}),e.add({id:1831,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:"The Odin client is the main entry point for the Odin SDK. It is used to create rooms. Create an instance with your access key and use it to create rooms.",content:`

export class OdinClient

The Odin client is the main entry point for the Odin SDK. It is used to create rooms. Create an instance with your access key and use it to create rooms.

Constructor

Name	Type	Description
constructor	OdinClient	Creates a new instance of a client. Use this to create rooms.

Public Methods

Name	Type	Description
createRoom	OdinRoom	Creates a new local room instance with the given ID and user ID. Use join to connect to that room.
createRoomWithAccessToken	OdinRoom	Creates a new local room instance with the given access token. Use `join` on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling `generateToken`. To be more consistent with other SDKs, this method is deprecated. Use createRoomWithToken instead.
createRoomWithToken	OdinRoom	Creates a new local room instance with the given room token. Use `join` on the returned OdinRoom instance to connect to that room. Use this method if you already have an access token, either created elsewhere or by calling `generateAccessToken`.
generateAccessToken	string	Generates a token for the given access key, room and user ID. This token can be used to join the room. To be more consistent with other SDKs, this method is deprecated. Use generateToken instead.
generateToken	string	Generates a room token for the given access key, room and user ID. This token can be used to join the room.

`}),e.add({id:1832,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Properties

Name	Type	Description
Rooms	RoomCollection	A collection of all Room
EndPoint	Uri	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	String	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData	IUserData	Client custom UserData

Public Methods

Name	Description
JoinRoom	Join or create a Room by name via a gateway
JoinNamedRoom	Join or create a named Room by token via a gateway
UpdateUserData	Updates the Rooms for the current peer
SetPositionScale	Updates the Rooms
UpdatePosition	Updates the Rooms
LeaveRoom	Leave a joined Room
Close	Completly closes this Client and all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1833,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi ",content:`

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Properties

Name	Type	Description
Rooms	RoomCollection	A collection of all Room
EndPoint	Uri	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	String	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData	IUserData	Client custom UserData

Public Methods

Name	Description
JoinRoom	Join or create a Room by name via a gateway
JoinNamedRoom	Join or create a named Room by token via a gateway
UpdateUserData	Updates the Rooms for the current peer
SetPositionScale	Updates the Rooms
UpdatePosition	Updates the Rooms
LeaveRoom	Leave a joined Room
Close	Completly closes this Client and all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1834,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi ",content:`

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Properties

Name	Type	Description
Rooms	RoomCollection	A collection of all Room
EndPoint	Uri	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	String	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData	IUserData	Client custom UserData

Public Methods

Name	Description
JoinRoom	Join or create a Room by name via a gateway
JoinNamedRoom	Join or create a named Room by token via a gateway
UpdateUserData	Updates the Rooms for the current peer
SetPositionScale	Updates the Rooms
UpdatePosition	Updates the Rooms
LeaveRoom	Leave a joined Room
Close	Completly closes this Client and all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1835,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi ",content:`

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Constructors

Name	Description
OdinClient(String, String)	Creates a new instance for ODIN ffi C# Wrapper
OdinClient(Uri, String)	Creates a new instance for ODIN ffi C# Wrapper
OdinClient(Uri, String, IUserData)	Creates a new instance for ODIN ffi C# Wrapper

Properties

Name	Description
Rooms	A collection of all Room
EndPoint	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData	Client custom UserData

Public Methods

Name	Description
JoinRoom	Join or create a Room by name via a gateway
JoinNamedRoom	Join or create a named Room by token via a gateway
UpdateUserData	Updates the Rooms for the current peer
SetPositionScale	Updates the Rooms
UpdatePosition	Updates the Rooms
LeaveRoom	Leave a joined Room
Close	Completly closes this Client and all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1836,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi OdinNative.Core.OdinLibrary.NativeMethods ",content:`

public class OdinClient : MarshalByRefObject, IDisposable

Client Wrapper for ODIN ffi OdinNative.Core.OdinLibrary.NativeMethods

Static Methods

Name	Description
Create	Creates a new initialized instance for ODIN ffi C# Wrapper
CreateAccessKey	Create a example access key that can be registered on 4Players (see https://developers.4players.io/odin/ )
CreateToken	Create a example token to join a room. For production use a token server!

Properties

Name	Description
Rooms	A collection of all Room
EndPoint	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData

Public Methods

Name	Description
GenerateToken	Create a example token to join a room. For production use a token server!
CreateRoom	Create a room for the set gateway.
JoinRoom	Create and join a Room
Join	Join a object of base Room
CloseRoom	Close a room by Id
FreeRoom	Close and remove a room by Id
BroadcastSendMessage	Send a message to all rooms with the default encoding UTF8
CloseRooms	Completely closes all Room associated.
FreeRooms	Free all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1837,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:" Client Wrapper for ODIN ffi ",content:`

public class OdinClient : IDisposable

Client Wrapper for ODIN ffi OdinLibrary

Constructors

Name	Description
OdinClient(String, String)	Creates a new instance for ODIN ffi C# Wrapper
OdinClient(Uri, String)	Creates a new instance for ODIN ffi C# Wrapper
OdinClient(Uri, String, IUserData)	Creates a new instance for ODIN ffi C# Wrapper

Properties

Name	Description
Rooms	A collection of all Room
EndPoint	Connection EndPoint. Default from OdinEditorConfig.
AccessKey	Client AccessKey for all new rooms. Default from OdinHandler config.
UserData	Client custom UserData

Public Methods

Name	Description
JoinRoom	Join or create a Room by name via a gateway
JoinNamedRoom	Join or create a named Room by token via a gateway
UpdateUserData	Updates the Rooms for the current peer
SetPositionScale	Updates the Rooms
UpdatePosition	Updates the Rooms
LeaveRoom	Leave a joined Room
Close	Completly closes this Client and all Room associated.
Dispose	On dispose will free all NativeMethods

`}),e.add({id:1838,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/",title:"OdinClient",section:"ODIN Documentation",description:"Class providing static methods to handle ODIN client connections.",content:`

export class OdinClient

Class providing static methods to handle ODIN client connections.

Properties

Name	Type	Description
config	IOdinClientSettings	Global settings for ODIN connections.
connectionState	OdinConnectionState	The current state of the main stream connection.
rooms	OdinRoom[]	An array of available `OdinRoom` instances.

Public Methods

Name	Type	Description
addEventListener	void	Registers to client events from `IOdinClientEvents`.
disconnect	void	Disconnects from all rooms and stops all audio handling.
initRoom	Promise<OdinRoom>	Authenticates against the ODIN server and returns an `OdinRoom` instance for the first room set in the specified token. This function accepts an optional `AudioContext` parameter for audio capture. The `AudioContext` interface is a part of the Web Audio API that represents an audio-processing graph, which can be used to control and manipulate audio signals in web applications. If the `AudioContext` is not provided or explicitly set to `undefined`, we will try to create one internally.
initRooms	Promise<OdinRoom[]>	Authenticates against the ODIN server and returns `OdinRoom` instances for all rooms set in the specified token. This function accepts an optional `AudioContext` parameter for audio capture. The `AudioContext` interface is a part of the Web Audio API that represents an audio-processing graph, which can be used to control and manipulate audio signals in web applications. If the `AudioContext` is not provided or explicitly set to `undefined`, we will try to create one internally.

`}),e.add({id:1839,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/constructor_0/",title:"OdinClient(String, String)",section:"ODIN Documentation",description:"",content:`

public OdinClient(string url, string accessKey)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin will be empty

Parameters

Name	Description
url	Odin Server
accessKey	Odin access key

`}),e.add({id:1840,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/constructor_0/",title:"OdinClient(String, String)",section:"ODIN Documentation",description:"",content:`

public OdinClient(string url, string accessKey)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin will be empty

Parameters

Name	Description
url	Odin Server
accessKey	Odin access key

`}),e.add({id:1841,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/constructor_2/",title:"OdinClient(Uri, String, IUserData)",section:"ODIN Documentation",description:"",content:`

public OdinClient(Uri server, string accessKey, IUserData userData = null)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin is optional

Parameters

Name	Description
server	Odin Server
accessKey	Odin access key
userData	to set

`}),e.add({id:1842,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/constructor_2/",title:"OdinClient(Uri, String, IUserData)",section:"ODIN Documentation",description:"",content:`

public OdinClient(Uri server, string accessKey, IUserData userData = null)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin is optional

Parameters

Name	Description
server	Odin Server
accessKey	Odin access key
userData	to set

`}),e.add({id:1843,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/constructor_1/",title:"OdinClient(Uri, String)",section:"ODIN Documentation",description:"",content:`

public OdinClient(Uri server, string accessKey)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin will be empty

Parameters

Name	Description
server	Odin Server
accessKey	Odin access key

`}),e.add({id:1844,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/constructor_1/",title:"OdinClient(Uri, String)",section:"ODIN Documentation",description:"",content:`

public OdinClient(Uri server, string accessKey)

Creates a new instance for ODIN ffi C# Wrapper

Info

Odin will be empty

Parameters

Name	Description
server	Odin Server
accessKey	Odin access key

`}),e.add({id:1845,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincolliderfiltercomponent/",title:"OdinColliderFilterComponent",section:"ODIN Documentation",description:" Custom filter by collider component for This class is a effect in the odin audio pipline to mute audio based on GameObject collisions in Unity space. The effect can help to trigger specific audio packets quickly without the adjustment of Server-side positions. ",content:`

Inherits from:

public class OdinColliderFilterComponent : OdinCustomEffectUnityComponentBase<IntPtr>, IOdinEffect

Custom filter by collider component for Media

This class is a effect in the odin audio pipline to mute audio based on GameObject collisions in Unity space. The effect can help to trigger specific audio packets quickly without the adjustment of Server-side positions.

Properties

Name	Description
ColliderTag
Comparison

Public Methods

Name	Description
SetTriggerCount
CustomEffectCallback

`}),e.add({id:1846,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/",title:"OdinConnection",section:"ODIN Documentation",description:" Wrapper class of Odin connections This convenient class provides dispatching of events to Unity with passthrough to support multiple rooms on fewer connections. ",content:`

public class OdinConnection : MonoBehaviour

Wrapper class of Odin connections

This convenient class provides dispatching of events to Unity with passthrough to support multiple rooms on fewer connections.

Properties

Name	Description
Settings	Native connection settings
Handle	Odin connection
OnDatagram	Redirect of OnDatagram
OnRpc	Redirect of OnRpc
EventUserdata	Custom connection userdata

`}),e.add({id:1847,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnectionpoolhandle/",title:"OdinConnectionPoolHandle",section:"ODIN Documentation",description:"",content:`

public class OdinConnectionPoolHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1848,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinconnectionpoolsettings/",title:"OdinConnectionPoolSettings",section:"ODIN Documentation",description:"",content:`

public struct OdinConnectionPoolSettings

Properties

Name	Description
user_data	IntPtr

`}),e.add({id:1849,href:"https://www.4players.io/odin/sdk/nodejs/types/odinconnectionstate/",title:"OdinConnectionState",section:"ODIN Documentation",description:"Connection states of the room",content:`

Connection states of the room

export type OdinConnectionState

Values

Name	Type
connecting	literal
connected	literal
disconnecting	literal
disconnected	literal
unknown	literal

`}),e.add({id:1850,href:"https://www.4players.io/odin/sdk/web/types/odinconnectionstate/",title:"OdinConnectionState",section:"ODIN Documentation",description:"Enum defining all possible connection states of the ODIN client.",content:`

Enum defining all possible connection states of the ODIN client.

export type OdinConnectionState

Values

Name	Type
disconnected	literal
connecting	literal
connected	literal
error	literal
incomplete	literal

`}),e.add({id:1851,href:"https://www.4players.io/odin/sdk/nodejs/types/odinconnectionstatechangedevent/",title:"OdinConnectionStateChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinConnectionStateChangedEvent = (event: OdinConnectionStateChangedEventPayload)

Parameters

Name	Type	Description
event	OdinConnectionStateChangedEventPayload

`}),e.add({id:1852,href:"https://www.4players.io/odin/sdk/web/types/odinconnectionstatechangedevent/",title:"OdinConnectionStateChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinConnectionStateChangedEvent = (event: IOdinEvent<IOdinConnectionStateChangedEventPayload>)

Discussion

The OdinConnectionStateChangedEvent event is emitted on OdinClient and OdinRoom instances when the internal connection state of the underlying main/room stream is updated. You can use the event to determine when your connection is closed unexpectedly (e.g. timeout or server shutdown).

Events are inheriting from IOdinEvent and provide an object described by IOdinConnectionStateChangedEventPayload in the payload property of the event.

Event Scopes

IOdinClientEvents
IOdinRoomEvents

Example

OdinConnectionStateChangedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Listen for connection state change events of the main stream
  odinRoom.addEventListener('ConnectionStateChanged', (event) => {
    console.log(\`Room connection state changed from \${event.payload.oldState} to \${event.payload.newState}\`);
  });

  // Join the room
  odinRoom.join();
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinConnectionStateChangedEventPayload>

`}),e.add({id:1853,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinconnectionstatechangedeventpayload/",title:"OdinConnectionStateChangedEventPayload",section:"ODIN Documentation",description:"The payload for the ConnectionStateChanged event.",content:`

export interface OdinConnectionStateChangedEventPayload

The payload for the ConnectionStateChanged event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
reason	OdinConnectionStateChangeReason	The error code if the connection state is Error.
state	OdinConnectionState	The new connection state of the room.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1854,href:"https://www.4players.io/odin/sdk/nodejs/types/odinconnectionstatechangereason/",title:"OdinConnectionStateChangeReason",section:"ODIN Documentation",description:"Change reasons for the connection state",content:`

Change reasons for the connection state

export type OdinConnectionStateChangeReason

Values

Name	Type
client_request	literal
server_request	literal
timeout	literal
unknown	literal

`}),e.add({id:1855,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/",title:"OdinConnectionStats",section:"ODIN Documentation",description:" Statistics for the underlying connection of a room. ",content:`

public struct OdinConnectionStats

Statistics for the underlying connection of a room.

Properties

Name	Type	Description
udp_tx_datagrams	UInt64	The amount of outgoing UDP datagrams observed
udp_tx_acks	UInt64	The amount of outgoing acknowledgement frames observed
udp_tx_bytes	UInt64	The total amount of bytes which have been transferred inside outgoing UDP datagrams
udp_rx_datagrams	UInt64	The amount of incoming UDP datagrams observed
udp_rx_acks	UInt64	The amount of incoming acknowledgement frames observed
udp_rx_bytes	UInt64	The total amount of bytes which have been transferred inside incoming UDP datagrams
cwnd	UInt64	Current congestion window of the connection
congestion_events	UInt64	Congestion events on the connection
rtt	Single	Current best estimate of the connection latency (round-trip-time) in milliseconds

`}),e.add({id:1856,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/",title:"OdinConnectionStats",section:"ODIN Documentation",description:" Statistics for the underlying connection of a room. ",content:`

public struct OdinConnectionStats

Statistics for the underlying connection of a room.

Properties

Name	Description
udp_tx_datagrams	The amount of outgoing UDP datagrams observed
udp_tx_acks	The amount of outgoing acknowledgement frames observed
udp_tx_bytes	The total amount of bytes which have been transferred inside outgoing UDP datagrams
udp_rx_datagrams	The amount of incoming UDP datagrams observed
udp_rx_acks	The amount of incoming acknowledgement frames observed
udp_rx_bytes	The total amount of bytes which have been transferred inside incoming UDP datagrams
cwnd	Current congestion window of the connection
congestion_events	Congestion events on the connection
rtt	Current best estimate of the connection latency (round-trip-time) in milliseconds

`}),e.add({id:1857,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/",title:"OdinConnectionStats",section:"ODIN Documentation",description:" Statistics for the underlying connection of a room. ",content:`

public struct OdinConnectionStats

Statistics for the underlying connection of a room.

Properties

Name	Description
udp_tx_datagrams	The amount of outgoing UDP datagrams observed
udp_tx_acks	The amount of outgoing acknowledgement frames observed
udp_tx_bytes	The total amount of bytes which have been transferred inside outgoing UDP datagrams
udp_rx_datagrams	The amount of incoming UDP datagrams observed
udp_rx_acks	The amount of incoming acknowledgement frames observed
udp_rx_bytes	The total amount of bytes which have been transferred inside incoming UDP datagrams
cwnd	Current congestion window of the connection
congestion_events	Congestion events on the connection
rtt	Current best estimate of the connection latency (round-trip-time) in milliseconds

`}),e.add({id:1858,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/",title:"OdinCustomEffectUnityComponentBase",section:"ODIN Documentation",description:" Custom base component for This convenient class provides effect template with a passthrough of custom userdata on a callback. The abstract representation of a base custom effect is to simplify implementation of as a Unity component. (see other predefined custom effects) ",content:`

public abstract class OdinCustomEffectUnityComponentBase<U> : MonoBehaviour, IOdinEffect where U : struct

Custom base component for Media

This convenient class provides effect template with a passthrough of custom userdata on a callback. The abstract representation of a base custom effect is to simplify implementation of Audio as a Unity component. (see other predefined custom effects)

Properties

Name	Description
Media	Get Media
Effect	Get base effect
IsCreated	Flag if the effect was added to the pipeline
IsEnabled	Flag if the component is active or use isActiveAndEnabled
DestroyOnError

Public Methods

Name	Description
GetEffectUserData	Get userdata used for the OdinCustomEffectUnityComponentBase%601
CustomEffectCallback	Callback delegate for the effect
ResetEffect	Removes an effect from the pipeline and add a new effect with callbacks
GetMedia	Get Media
GetEffect	Get custom effect

`}),e.add({id:1859,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/",title:"OdinDatagramRecv",section:"ODIN Documentation",description:"",content:`

public struct OdinDatagramRecv

Properties

Name	Description
media_id
rtt_milliseconds
sequence_number
timestamp
is_end_of_spurt
payload	byte[]
payload_length

Public Methods

Name	Description
UpdatePinnedPayload

`}),e.add({id:1860,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/",title:"OdinDatagramSend",section:"ODIN Documentation",description:"",content:`

public struct OdinDatagramSend

Properties

Name	Description
sequence_number
timestamp
is_end_of_spurt
payload	byte[]
payload_length

`}),e.add({id:1861,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindecoderhandle/",title:"OdinDecoderHandle",section:"ODIN Documentation",description:"",content:`

public class OdinDecoderHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1862,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Type	Description
Verbose	Boolean	Enable additional logs
Debug	Boolean	Enable additional debug logs
AccessKey	String	Default access key
Server	String	Default server url
UserDataText	String	Default text representation of UserData
DeviceSampleRate	MediaSampleRate	Microphone default Sample-Rate
DeviceChannels	MediaChannels	Microphone default Channel
RemoteSampleRate	MediaSampleRate	Playback default Sample-Rate
RemoteChannels	MediaChannels	Playback default Channel
PeerJoinedEvent	Boolean	Idicates whether the event is enabled by default
PeerLeftEvent	Boolean	Idicates whether the event is enabled by default
PeerUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaAddedEvent	Boolean	Idicates whether the event is enabled by default
MediaRemovedEvent	Boolean	Idicates whether the event is enabled by default
RoomUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaActiveStateChangedEvent	Boolean	Idicates whether the event is enabled by default
MessageReceivedEvent	Boolean	Idicates whether the event is enabled by default
TokenLifetime	UInt64	JWT room token lifetime
VoiceActivityDetection	Boolean	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Single	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Single	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Boolean	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Single	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Single	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Boolean	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Boolean	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Boolean	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Boolean	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1863,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Type	Description
Verbose	Boolean	Enable additional logs
Debug	Boolean	Enable additional debug logs
AccessKey	String	Default access key
Server	String	Default server url
UserDataText	String	Default text representation of UserData
DeviceSampleRate	MediaSampleRate	Microphone default Sample-Rate
DeviceChannels	MediaChannels	Microphone default Channel
RemoteSampleRate	MediaSampleRate	Playback default Sample-Rate
RemoteChannels	MediaChannels	Playback default Channel
PeerJoinedEvent	Boolean	Idicates whether the event is enabled by default
PeerLeftEvent	Boolean	Idicates whether the event is enabled by default
PeerUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaAddedEvent	Boolean	Idicates whether the event is enabled by default
MediaRemovedEvent	Boolean	Idicates whether the event is enabled by default
RoomUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaActiveStateChangedEvent	Boolean	Idicates whether the event is enabled by default
MessageReceivedEvent	Boolean	Idicates whether the event is enabled by default
TokenLifetime	UInt64	JWT room token lifetime
VoiceActivityDetection	Boolean	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Single	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Single	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Boolean	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Single	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Single	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Boolean	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Boolean	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Boolean	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Boolean	Idicates whether the ApmConfig setting is enabled by default
GainController	Boolean	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1864,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Type	Description
Verbose	Boolean	Enable additional logs
Debug	Boolean	Enable additional debug logs
AccessKey	String	Default access key
Server	String	Default server url
UserDataText	String	Default text representation of UserData
DeviceSampleRate	MediaSampleRate	Microphone default Sample-Rate
DeviceChannels	MediaChannels	Microphone default Channel
RemoteSampleRate	MediaSampleRate	Playback default Sample-Rate
RemoteChannels	MediaChannels	Playback default Channel
PeerJoinedEvent	Boolean	Idicates whether the event is enabled by default
PeerLeftEvent	Boolean	Idicates whether the event is enabled by default
PeerUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaAddedEvent	Boolean	Idicates whether the event is enabled by default
MediaRemovedEvent	Boolean	Idicates whether the event is enabled by default
RoomUpdatedEvent	Boolean	Idicates whether the event is enabled by default
MediaActiveStateChangedEvent	Boolean	Idicates whether the event is enabled by default
MessageReceivedEvent	Boolean	Idicates whether the event is enabled by default
TokenLifetime	UInt64	JWT room token lifetime
VoiceActivityDetection	Boolean	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Single	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Single	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Boolean	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Single	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Single	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Boolean	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Boolean	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Boolean	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Boolean	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1865,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Description
Verbose	Enable additional logs
Debug	Enable additional debug logs
AccessKey	Default access key
Server	Default server url
UserDataText	Default text representation of UserData
DeviceSampleRate	Microphone default Sample-Rate
DeviceChannels	Microphone default Channel
RemoteSampleRate	Playback default Sample-Rate
RemoteChannels	Playback default Channel
PeerJoinedEvent	Idicates whether the event is enabled by default
PeerLeftEvent	Idicates whether the event is enabled by default
PeerUpdatedEvent	Idicates whether the event is enabled by default
MediaAddedEvent	Idicates whether the event is enabled by default
MediaRemovedEvent	Idicates whether the event is enabled by default
RoomUpdatedEvent	Idicates whether the event is enabled by default
MediaActiveStateChangedEvent	Idicates whether the event is enabled by default
MessageReceivedEvent	Idicates whether the event is enabled by default
TokenLifetime	JWT room token lifetime
VoiceActivityDetection	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Idicates whether the ApmConfig setting is enabled by default
GainController	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1866,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Description
Verbose	Enable additional logs
Debug	Enable additional debug logs
AccessKey	Default access key
Server	Default server url
UserDataText	Default text representation of UserData
TokenLifetime	JWT room token lifetime
VoiceActivityDetection	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Idicates whether the ApmConfig setting is enabled by default
GainController	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1867,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/",title:"OdinDefaults",section:"ODIN Documentation",description:" ODIN default configuration ",content:`

public static class OdinDefaults

ODIN default configuration

Static Properties

Name	Description
Verbose	Enable additional logs
Debug	Enable additional debug logs
AccessKey	Default access key
Server	Default server url
UserDataText	Default text representation of UserData
DeviceSampleRate	Microphone default Sample-Rate
DeviceChannels	Microphone default Channel
RemoteSampleRate	Playback default Sample-Rate
RemoteChannels	Playback default Channel
PeerJoinedEvent	Idicates whether the event is enabled by default
PeerLeftEvent	Idicates whether the event is enabled by default
PeerUpdatedEvent	Idicates whether the event is enabled by default
MediaAddedEvent	Idicates whether the event is enabled by default
MediaRemovedEvent	Idicates whether the event is enabled by default
RoomUpdatedEvent	Idicates whether the event is enabled by default
MediaActiveStateChangedEvent	Idicates whether the event is enabled by default
MessageReceivedEvent	Idicates whether the event is enabled by default
TokenLifetime	JWT room token lifetime
VoiceActivityDetection	Idicates whether the ApmConfig setting is enabled by default
VoiceActivityDetectionAttackProbability	Idicates the vad attack probability ApmConfig setting by default
VoiceActivityDetectionReleaseProbability	Idicates the vad release probability ApmConfig setting by default
VolumeGate	Idicates whether the ApmConfig setting is enabled by default
VolumeGateAttackLoudness	Idicates the gate attack loudness ApmConfig setting by default
VolumeGateReleaseLoudness	Idicates the gate release loudness ApmConfig setting by default
EchoCanceller	Idicates whether the ApmConfig setting is enabled by default
HighPassFilter	Idicates whether the ApmConfig setting is enabled by default
PreAmplifier	Idicates whether the ApmConfig setting is enabled by default
NoiseSuppressionLevel	Idicates the level of noise suppression ApmConfig setting by default
TransientSuppressor	Idicates whether the ApmConfig setting is enabled by default
GainController	Idicates whether the ApmConfig setting is enabled by default

`}),e.add({id:1868,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/",title:"OdinEditorConfig",section:"ODIN Documentation",description:" UnityEditor UI component for instance config of ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinEditorConfig : MonoBehaviour, IOdinApmConfig

UnityEditor UI component for instance config of Odin

Properties

Name	Type	Description
Verbose	Boolean	Enable additional Logs
VerboseDebug	Boolean	Enable additional Logs
AccessKey	String	Odin Client ApiKey
ClientId	String	Odin Client ID
Server	String	Gateway
UserDataText	String	Default UserData content
DeviceSampleRate	MediaSampleRate	Microphone Sample-Rate
DeviceChannels	MediaChannels	Microphone Channels
RemoteSampleRate	MediaSampleRate	Playback Sample-Rate
RemoteChannels	MediaChannels	Playback Channels
PeerJoinedEvent	Boolean
PeerLeftEvent	Boolean
PeerUpdatedEvent	Boolean
MediaAddedEvent	Boolean
MediaRemovedEvent	Boolean
RoomUpdatedEvent	Boolean
MediaActiveStateChangedEvent	Boolean
MessageReceivedEvent	Boolean
TokenLifetime	UInt64	Time untill the token expires
VoiceActivityDetection	Boolean	Turns VAD on and off
VoiceActivityDetectionAttackProbability	Single	Setup engage of VAD
VoiceActivityDetectionReleaseProbability	Single	Setup disengage of VAD
VolumeGate	Boolean	Turns volume gate on and off
VolumeGateAttackLoudness	Single	Setup engage of volume gate
VolumeGateReleaseLoudness	Single	Setup disengage of volume gate
EchoCanceller	Boolean	Turns Echo cancellation on and off
HighPassFilter	Boolean	Reduces lower frequencies of the input (Automatic game control)
PreAmplifier	Boolean	Amplifies the audio input
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Turns noise suppression on and off
TransientSuppressor	Boolean	Filters high amplitude noices

Public Methods

Name	Description
GenerateUIAccessKey

`}),e.add({id:1869,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/",title:"OdinEditorConfig",section:"ODIN Documentation",description:" UnityEditor UI component for instance config of ",content:`

public class OdinEditorConfig : MonoBehaviour

UnityEditor UI component for instance config of Odin

Properties

Name	Type	Description
Verbose	Boolean	Enable additional Logs
VerboseDebug	Boolean	Enable additional Logs
AccessKey	String	Odin Client ApiKey
ClientId	String	Odin Client ID
Server	String	Gateway
UserDataText	String	Default UserData content
DeviceSampleRate	MediaSampleRate	Microphone Sample-Rate
DeviceChannels	MediaChannels	Microphone Channels
RemoteSampleRate	MediaSampleRate	Playback Sample-Rate
RemoteChannels	MediaChannels	Playback Channels
PeerJoinedEvent	Boolean
PeerLeftEvent	Boolean
PeerUpdatedEvent	Boolean
MediaAddedEvent	Boolean
MediaRemovedEvent	Boolean
RoomUpdatedEvent	Boolean
MediaActiveStateChangedEvent	Boolean
MessageReceivedEvent	Boolean
TokenLifetime	UInt64	Time untill the token expires
VoiceActivityDetection	Boolean	Turns VAD on and off
VoiceActivityDetectionAttackProbability	Single	Setup engage of VAD
VoiceActivityDetectionReleaseProbability	Single	Setup disengage of VAD
VolumeGate	Boolean	Turns volume gate on and off
VolumeGateAttackLoudness	Single	Setup engage of volume gate
VolumeGateReleaseLoudness	Single	Setup disengage of volume gate
EchoCanceller	Boolean	Turns Echo cancellation on and off
HighPassFilter	Boolean	Reduces lower frequencies of the input (Automatic game control)
PreAmplifier	Boolean	Amplifies the audio input
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Turns noise suppression on and off
TransientSuppressor	Boolean	Filters high amplitude noices
GainController	Boolean	Turns gain controller on and off

Public Methods

Name	Description
GenerateUIAccessKey

`}),e.add({id:1870,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/",title:"OdinEditorConfig",section:"ODIN Documentation",description:" UnityEditor UI component for instance config of ",content:`

public class OdinEditorConfig : MonoBehaviour, IOdinApmConfig

UnityEditor UI component for instance config of Odin

Properties

Name	Type	Description
Verbose	Boolean	Enable additional Logs
VerboseDebug	Boolean	Enable additional Logs
AccessKey	String	Odin Client ApiKey
ClientId	String	Odin Client ID
Server	String	Gateway
UserDataText	String	Default UserData content
DeviceSampleRate	MediaSampleRate	Microphone Sample-Rate
DeviceChannels	MediaChannels	Microphone Channels
RemoteSampleRate	MediaSampleRate	Playback Sample-Rate
RemoteChannels	MediaChannels	Playback Channels
PeerJoinedEvent	Boolean
PeerLeftEvent	Boolean
PeerUpdatedEvent	Boolean
MediaAddedEvent	Boolean
MediaRemovedEvent	Boolean
RoomUpdatedEvent	Boolean
MediaActiveStateChangedEvent	Boolean
MessageReceivedEvent	Boolean
TokenLifetime	UInt64	Time untill the token expires
VoiceActivityDetection	Boolean	Turns VAD on and off
VoiceActivityDetectionAttackProbability	Single	Setup engage of VAD
VoiceActivityDetectionReleaseProbability	Single	Setup disengage of VAD
VolumeGate	Boolean	Turns volume gate on and off
VolumeGateAttackLoudness	Single	Setup engage of volume gate
VolumeGateReleaseLoudness	Single	Setup disengage of volume gate
EchoCanceller	Boolean	Turns Echo cancellation on and off
HighPassFilter	Boolean	Reduces lower frequencies of the input (Automatic game control)
PreAmplifier	Boolean	Amplifies the audio input
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Turns noise suppression on and off
TransientSuppressor	Boolean	Filters high amplitude noices
GainController	Boolean	Turns gain controller on and off

Public Methods

Name	Description
GenerateUIAccessKey

`}),e.add({id:1871,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/",title:"OdinEditorConfig",section:"ODIN Documentation",description:" UnityEditor UI component for instance config of ",content:`

public class OdinEditorConfig : MonoBehaviour

UnityEditor UI component for instance config of Odin

Properties

Name	Description
Verbose	Enable additional Logs
VerboseDebug	Enable additional Logs
AccessKey	Odin Client ApiKey
ClientId	Odin Client ID
Server	Gateway
UserDataText	Default UserData content
DeviceSampleRate	Microphone Sample-Rate
DeviceChannels	Microphone Channels
RemoteSampleRate	Playback Sample-Rate
RemoteChannels	Playback Channels
PeerJoinedEvent
PeerLeftEvent
PeerUpdatedEvent
MediaAddedEvent
MediaRemovedEvent
RoomUpdatedEvent
MediaActiveStateChangedEvent
MessageReceivedEvent
TokenLifetime	Time untill the token expires
VoiceActivityDetection	Turns VAD on and off
VoiceActivityDetectionAttackProbability	Setup engage of VAD
VoiceActivityDetectionReleaseProbability	Setup disengage of VAD
VolumeGate	Turns volume gate on and off
VolumeGateAttackLoudness	Setup engage of volume gate
VolumeGateReleaseLoudness	Setup disengage of volume gate
EchoCanceller	Turns Echo cancellation on and off
HighPassFilter	Reduces lower frequencies of the input (Automatic game control)
PreAmplifier	Amplifies the audio input
NoiseSuppressionLevel	Turns noise suppression on and off
TransientSuppressor	Filters high amplitude noices
GainController	Turns gain controller on and off

Public Methods

Name	Description
GenerateUIAccessKey

`}),e.add({id:1872,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/",title:"OdinEditorConfig",section:"ODIN Documentation",description:" UnityEditor UI component for instance config of ",content:`

public class OdinEditorConfig : MonoBehaviour

UnityEditor UI component for instance config of Odin

Properties

Name	Description
Verbose	Enable additional Logs
VerboseDebug	Enable additional Logs
AccessKey	Odin Client ApiKey
ClientId	Odin Client ID
Server	Gateway
UserDataText	Default UserData content
DeviceSampleRate	Microphone Sample-Rate
DeviceChannels	Microphone Channels
RemoteSampleRate	Playback Sample-Rate
RemoteChannels	Playback Channels
PeerJoinedEvent
PeerLeftEvent
PeerUpdatedEvent
MediaAddedEvent
MediaRemovedEvent
RoomUpdatedEvent
MediaActiveStateChangedEvent
MessageReceivedEvent
TokenLifetime	Time untill the token expires
VoiceActivityDetection	Turns VAD on and off
VoiceActivityDetectionAttackProbability	Setup engage of VAD
VoiceActivityDetectionReleaseProbability	Setup disengage of VAD
VolumeGate	Turns volume gate on and off
VolumeGateAttackLoudness	Setup engage of volume gate
VolumeGateReleaseLoudness	Setup disengage of volume gate
EchoCanceller	Turns Echo cancellation on and off
HighPassFilter	Reduces lower frequencies of the input (Automatic game control)
PreAmplifier	Amplifies the audio input
NoiseSuppressionLevel	Turns noise suppression on and off
TransientSuppressor	Filters high amplitude noices
GainController	Turns gain controller on and off

Public Methods

Name	Description
GenerateUIAccessKey

`}),e.add({id:1873,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odineffecttype/",title:"OdinEffectType",section:"ODIN Documentation",description:"",content:`

public enum OdinEffectType

Properties

Name	Description
ODIN_EFFECT_TYPE_VAD
ODIN_EFFECT_TYPE_APM
ODIN_EFFECT_TYPE_CUSTOM

`}),e.add({id:1874,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinencoderhandle/",title:"OdinEncoderHandle",section:"ODIN Documentation",description:"",content:`

public class OdinEncoderHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1875,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinerror/",title:"OdinError",section:"ODIN Documentation",description:" Odin error codes where negative values are errors and positive values status codes Successful status code equivalent with "end of data"Successful status code generic OK ",content:`

public enum OdinError

Odin error codes where negative values are errors and positive values status codes

OdinErrorSuccessful status code generic OK

Properties

Name	Description
ODIN_ERROR_NO_DATA	Successful status code equivalent with "end of data"
ODIN_ERROR_SUCCESS	Successful status code OK
ODIN_ERROR_APM_ERROR
ODIN_ERROR_ARGUMENT_INVALID_STRING
ODIN_ERROR_ARGUMENT_INVALID_HANDLE
ODIN_ERROR_ARGUMENT_NULL
ODIN_ERROR_ARGUMENT_INVALID_ID
ODIN_ERROR_ARGUMENT_OUT_OF_BOUNDS
ODIN_ERROR_END_ARGUMENT_ERRORS
ODIN_ERROR_INITIALIZATION_FAILED
ODIN_ERROR_INVALID_ACCESS_KEY
ODIN_ERROR_INVALID_GATEWAY_URI
ODIN_ERROR_INVALID_STATE
ODIN_ERROR_INVALID_TOKEN
ODIN_ERROR_INVALID_VERSION
ODIN_ERROR_OPUS_ERROR
ODIN_ERROR_DECODER_ERROR
ODIN_ERROR_TOKEN_ROOM_REJECTED
ODIN_ERROR_UNSUPPORTED_VERSION
ODIN_ERROR_UNSUPPORTED_EFFECT
ODIN_ERROR_CLOSED

`}),e.add({id:1876,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/odinerrortostring/",title:"OdinErrorToString",section:"ODIN Documentation",description:"",content:`

public static string OdinErrorToString(NativeBindings.OdinError error)

Retrieves the name of the constant in the specified NativeBindings

Parameters

Name	Type	Description
error	OdinError	Odin error return code

Returns

Type	Description
String	string representation of

`}),e.add({id:1877,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odineventpayload/",title:"OdinEventPayload",section:"ODIN Documentation",description:"The base event payload that is passed to all events.",content:`

export interface OdinEventPayload

The base event payload that is passed to all events.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1878,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/",title:"OdinEvents",section:"ODIN Documentation",description:"Defines available Odin events",content:`

export interface OdinEvents

Defines available Odin events

Properties

Name	Type	Description
AudioDataReceived	OdinAudioDataReceivedEvent	Fired when audio data is available for media streams. Audio comes in 16 bit and 32 bit float samples and are available individually for each peer. You can use the samples to record audio or send them to an AI for transcription.
ConnectionStateChanged	OdinConnectionStateChangedEvent	Fired when the connection state of the room changed.
Joined	OdinJoinedEvent	Fired when the local user connected to the room (successfully joined).
Left	OdinLeftEvent	Fired when the local user disconnected from the room (left).
MediaActivity	OdinMediaActivityEvent	Fired when a media stream was activated or deactivated. The active flag is true if the user started to talk and false if the user stopped talking.
MediaAdded	OdinMediaAddedEvent	Fired when a media stream was added to a peer. This happens for example if a peer adds a microphone to the room
MediaRemoved	OdinMediaRemovedEvent	Fired when a media stream was removed from a peer. This happens for example if a peer removes a microphone from the room
MessageReceived	OdinMessageReceivedEvent	Fired when a remote peer sent a message to the room.
PeerJoined	OdinPeerJoinedEvent	Fired when a remote peer joined the room. This event is fired for all existing peers in the room before the Joined event is fired.
PeerLeft	OdinPeerLeftEvent	Fired when a remote peer left the room.
PeerUserDataChanged	OdinPeerUserDataChangedEvent	Fired when the user data of a remote peer changed.
RoomUserDataChanged	OdinRoomUserDataChangedEvent	Fired when the user data of the room changed.

`}),e.add({id:1879,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinException : Exception

Exception type for the native ODIN runtime

Properties

Name	Type	Description
ErrorCode	UInt32	OdinErrorCode

`}),e.add({id:1880,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

Inherits from:

public class OdinException : Exception, ISerializable, _Exception

Exception type for the native ODIN runtime

Properties

Name	Type	Description
ErrorCode	UInt32	OdinErrorCode

`}),e.add({id:1881,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

public class OdinException : Exception

Exception type for the native ODIN runtime

Properties

Name	Type	Description
ErrorCode	UInt32	OdinErrorCode

`}),e.add({id:1882,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

Inherits from:

public class OdinException : Exception, ISerializable, _Exception

Exception type for the native ODIN runtime

Constructors

Name	Description
OdinException(UInt32, String)	OdinErrorCode container
OdinException(UInt32, String, Exception)	OdinErrorCode container

Properties

Name	Description
ErrorCode	OdinErrorCode

`}),e.add({id:1883,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

public class OdinException : Exception

Exception type for the native ODIN runtime

Constructors

Name	Description
OdinException(OdinError, String)	OdinErrorCode container
OdinException(OdinError, String, Exception)	OdinErrorCode container

Properties

Name	Description
ErrorCode	OdinErrorCode

`}),e.add({id:1884,href:"https://www.4players.io/odin/sdk/unity/classes/odinexception/",title:"OdinException",section:"ODIN Documentation",description:" Exception type for the native ODIN runtime ",content:`

Inherits from:

public class OdinException : Exception, ISerializable, _Exception

Exception type for the native ODIN runtime

Constructors

Name	Description
OdinException(UInt32, String)	OdinErrorCode container
OdinException(UInt32, String, Exception)	OdinErrorCode container

Properties

Name	Description
ErrorCode	OdinErrorCode

`}),e.add({id:1885,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinexception/constructor_1/",title:"OdinException(OdinError, String, Exception)",section:"ODIN Documentation",description:"",content:`

public OdinException(OdinError error, string message, Exception innerException)

OdinErrorCode container

Parameters

Name	Description
error	OdinError enum
message	odin error message
innerException	wrapper inner

`}),e.add({id:1886,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinexception/constructor_0/",title:"OdinException(OdinError, String)",section:"ODIN Documentation",description:"",content:`

public OdinException(OdinError error, string message)

OdinErrorCode container

Parameters

Name	Description
error	OdinError enum
message	odin error message

`}),e.add({id:1887,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinexception/constructor_1/",title:"OdinException(UInt32, String, Exception)",section:"ODIN Documentation",description:"",content:`

public OdinException(uint error, string message, Exception innerException)

OdinErrorCode container

Parameters

Name	Description
error	OdinErrorCode
message	odin error message
innerException	wrapper inner

`}),e.add({id:1888,href:"https://www.4players.io/odin/sdk/unity/classes/odinexception/constructor_1/",title:"OdinException(UInt32, String, Exception)",section:"ODIN Documentation",description:"",content:`

public OdinException(uint error, string message, Exception innerException)

OdinErrorCode container

Parameters

Name	Description
error	OdinErrorCode
message	odin error message
innerException	wrapper inner

`}),e.add({id:1889,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinexception/constructor_0/",title:"OdinException(UInt32, String)",section:"ODIN Documentation",description:"",content:`

public OdinException(uint error, string message)

OdinErrorCode container

Parameters

Name	Description
error	OdinErrorCode
message	odin error message

`}),e.add({id:1890,href:"https://www.4players.io/odin/sdk/unity/classes/odinexception/constructor_0/",title:"OdinException(UInt32, String)",section:"ODIN Documentation",description:"",content:`

public OdinException(uint error, string message)

OdinErrorCode container

Parameters

Name	Description
error	OdinErrorCode
message	odin error message

`}),e.add({id:1891,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/",title:"OdinHandler",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinHandler : MonoBehaviour

Discussion

Properties

Name	Type	Description
HasConnections	Boolean	True if any Room is joined
Microphone	MicrophoneReader	Unity Component that handles one Microphone where data gets routed through (n) Media
Rooms	RoomCollection
OnRoomJoin	RoomJoinProxy	Called before an actual room join
OnRoomJoined	RoomJoinedProxy	Called after a room is joined successfully
OnRoomLeave	RoomLeaveProxy	Called before a room leave
OnRoomLeft	RoomLeftProxy	Called after a room is destroyed
OnPeerJoined	PeerJoinedProxy	Called on every Peer that joins the room(s) we're connected to
OnPeerUserDataChanged	PeerUserDataChangedProxy	Called on every Peer that updates his UserData in the same room(s)
OnPeerLeft	PeerLeftProxy	Called on every Peer that left in the same room(s)
OnMediaAdded	MediaAddedProxy	Called on every Peer that created a media in the same room(s)
OnMediaRemoved	MediaRemovedProxy	Called on every Peer that closed/destroyed one of his own media in the same room(s)
OnMediaActiveStateChanged	MediaActiveStateChangedProxy	Called on every activity change of a media in the same room(s)
OnRoomUserDataChanged	RoomUserDataChangedProxy	Called on the Room that updates his UserData
OnMessageReceived	MessageReceivedProxy	Called on every Peer that received message from a peer by
OnConnectionStateChanged	ConnectionStateChangedProxy	Called on the Room that changed the connection state
OnCreatedMediaObject	UnityCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
OnDeleteMediaObject	UnityDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
UnityAudioSourceTag	String	Identify by Unity-Tag to attach a Audio
Use3DAudio	Boolean	Enable 3D Audio via preset Odin
CreatePlayback	Boolean	Creates Room_OnMediaAdded(System events
PlaybackAudioMixer	AudioMixer
PlaybackAudioMixerGroup	AudioMixerGroup

Static Properties

Name	Type	Description
Config	OdinEditorConfig	Static reference to the global Unity
Instance	OdinHandler	Singleton reference to this OdinHandler

Public Methods

Name	Description
GetUserData
JoinRoom	Join or create a room by name and attach a Media
LeaveRoom	Leave and free the Room by name
AddPlaybackComponent	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
GetOrCreateMicrophoneStream	Returns the attached Audio
RoomsSetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in each room
RoomsUpdatePosition	Updates the two-dimensional position of our own peer in each room
UpdateUserData	Updates the UserData for all Rooms
GetRoom	Gets the room object from Odin
GetPeer	Gets the a Peer object from a specified room matching a peer ID
GetMedia	Get the PlaybackStream of a peer in the room
GetPeers	Get all remote peers inside a room
BroadcastMessage	Sends arbitrary data to a all remote peers in all rooms
GetPlaybackComponents	Gets all Audio across all rooms
GetPlaybackComponent	Gets a Audio
DestroyPlaybackComponents	Destroys all Audio instances

`}),e.add({id:1892,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/",title:"OdinHandler",section:"ODIN Documentation",description:"",content:`

public class OdinHandler : MonoBehaviour

Discussion

Properties

Name	Type	Description
HasConnections	Boolean	True if any Room is joined
Microphone	MicrophoneReader	Unity Component that handles one Microphone where data gets routed through (n) Media
Rooms	RoomCollection
OnRoomJoin	RoomJoinProxy	Called before an actual room join
OnRoomJoined	RoomJoinedProxy	Called after a room is joined successfully
OnRoomLeave	RoomLeaveProxy	Called before a room leave
OnRoomLeft	RoomLeftProxy	Called after a room is destroyed
OnPeerJoined	PeerJoinedProxy	Called on every Peer that joins the room(s) we're connected to
OnPeerUserDataChanged	PeerUserDataChangedProxy	Called on every Peer that updates his UserData in the same room(s)
OnPeerLeft	PeerLeftProxy	Called on every Peer that left in the same room(s)
OnMediaAdded	MediaAddedProxy	Called on every Peer that created a media in the same room(s)
OnMediaRemoved	MediaRemovedProxy	Called on every Peer that closed/destroyed one of his own media in the same room(s)
OnMediaActiveStateChanged	MediaActiveStateChangedProxy	Called on every activity change of a media in the same room(s)
OnRoomUserDataChanged	RoomUserDataChangedProxy	Called on the Room that updates his UserData
OnMessageReceived	MessageReceivedProxy	Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem
OnConnectionStateChanged	ConnectionStateChangedProxy	Called on the Room that changed the connection state
OnCreatedMediaObject	UnityCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
OnDeleteMediaObject	UnityDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
UnityAudioSourceTag	String	Identify by Unity-Tag to attach a Audio
Use3DAudio	Boolean	Enable 3D Audio via preset Odin
CreatePlayback	Boolean	Creates Room_OnMediaAdded(System events
PlaybackAudioMixer	AudioMixer
PlaybackAudioMixerGroup	AudioMixerGroup

Static Properties

Name	Type	Description
Config	OdinEditorConfig	Static reference to the global Unity
Instance	OdinHandler	Singleton reference to this OdinHandler

Public Methods

Name	Description
GetUserData
JoinRoom	Join or create a room by name and attach a Media
LeaveRoom	Leave and free the Room by name
AddPlaybackComponent	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
GetOrCreateMicrophoneStream	Returns the attached Audio
RoomsSetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in each room
RoomsUpdatePosition	Updates the two-dimensional position of our own peer in each room
UpdateUserData	Updates the Rooms
GetRoom	Gets the room object from Odin
GetPeer	Gets the a Peer object from a specified room matching a peer ID
GetMedia	Get the PlaybackStream of a peer in the room
GetPeers	Get all remote peers inside a room
BroadcastMessage	Sends arbitrary data to a all remote peers in all rooms
GetPlaybackComponents	Gets all Audio across all rooms
GetPlaybackComponent	Gets a Audio
DestroyPlaybackComponents	Destroys all Audio instances

`}),e.add({id:1893,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/",title:"OdinHandler",section:"ODIN Documentation",description:"",content:`

public class OdinHandler : MonoBehaviour

Discussion

Properties

Name	Type	Description
HasConnections	Boolean	True if any Room is joined
Microphone	MicrophoneReader	Unity Component that handles one Microphone where data gets routed through (n) Media
Rooms	RoomCollection
OnRoomJoin	RoomJoinProxy	Called before an actual room join
OnRoomJoined	RoomJoinedProxy	Called after a room is joined successfully
OnRoomLeave	RoomLeaveProxy	Called before a room leave
OnRoomLeft	RoomLeftProxy	Called after a room is destroyed
OnPeerJoined	PeerJoinedProxy	Called on every Peer that joins the room(s) we're connected to
OnPeerUserDataChanged	PeerUserDataChangedProxy	Called on every Peer that updates his UserData in the same room(s)
OnPeerLeft	PeerLeftProxy	Called on every Peer that left in the same room(s)
OnMediaAdded	MediaAddedProxy	Called on every Peer that created a media in the same room(s)
OnMediaRemoved	MediaRemovedProxy	Called on every Peer that closed/destroyed one of his own media in the same room(s)
OnMediaActiveStateChanged	MediaActiveStateChangedProxy	Called on every activity change of a media in the same room(s)
OnRoomUserDataChanged	RoomUserDataChangedProxy	Called on the Room that updates his UserData
OnMessageReceived	MessageReceivedProxy	Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem
OnConnectionStateChanged	ConnectionStateChangedProxy	Called on the Room that changed the connection state
OnCreatedMediaObject	UnityCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
OnDeleteMediaObject	UnityDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
UnityAudioSourceTag	String	Identify by Unity-Tag to attach a Audio
Use3DAudio	Boolean	Enable 3D Audio via preset Odin
CreatePlayback	Boolean	Creates Room_OnMediaAdded(System events
PlaybackAudioMixer	AudioMixer
PlaybackAudioMixerGroup	AudioMixerGroup

Static Properties

Name	Type	Description
Config	OdinEditorConfig	Static reference to the global Unity
Instance	OdinHandler	Singleton reference to this OdinHandler

Public Methods

Name	Description
GetUserData
JoinRoom	Join or create a room by name and attach a Media
LeaveRoom	Leave and free the Room by name
AddPlaybackComponent	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
GetOrCreateMicrophoneStream	Returns the attached Audio
RoomsSetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in each room
RoomsUpdatePosition	Updates the two-dimensional position of our own peer in each room
UpdateUserData	Updates the Rooms
GetRoom	Gets the room object from Odin
GetPeer	Gets the a Peer object from a specified room matching a peer ID
GetMedia	Get the PlaybackStream of a peer in the room
GetPeers	Get all remote peers inside a room
BroadcastMessage	Sends arbitrary data to a all remote peers in all rooms
GetPlaybackComponents	Gets all Audio across all rooms
GetPlaybackComponent	Gets a Audio
DestroyPlaybackComponents	Destroys all Audio instances

`}),e.add({id:1894,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/",title:"OdinHandler",section:"ODIN Documentation",description:" The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes. ",content:`

public class OdinHandler : MonoBehaviour

Properties

Name	Description
HasConnections	True if any Room is joined
Microphone	Unity Component that handles one Microphone where data gets routed through (n) Media
Rooms
OnRoomJoin	Called before an actual room join
OnRoomJoined	Called after a room is joined successfully
OnRoomLeave	Called before a room leave
OnRoomLeft	Called after a room is destroyed
OnPeerJoined	Called on every Peer that joins the room(s) we're connected to
OnPeerUserDataChanged	Called on every Peer that updates his UserData in the same room(s)
OnPeerLeft	Called on every Peer that left in the same room(s)
OnMediaAdded	Called on every Peer that created a media in the same room(s)
OnMediaRemoved	Called on every Peer that closed/destroyed one of his own media in the same room(s)
OnMediaActiveStateChanged	Called on every activity change of a media in the same room(s)
OnRoomUserDataChanged	Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.
OnMessageReceived	Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem
OnConnectionStateChanged	Called on the Room that changed the connection state
OnCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
OnDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
UnityAudioSourceTag	Identify by Unity-Tag to attach a Audio
Use3DAudio	Enable 3D Audio via preset Odin
CreatePlayback	Creates Room_OnMediaAdded(System events
PlaybackAudioMixer
PlaybackAudioMixerGroup

Static Properties

Name	Description
Config	Static reference to the global Unity
Instance	Singleton reference to this OdinHandler

Public Methods

Name	Description
GetUserData
JoinRoom	Join or create a room by name and attach a Media
LeaveRoom	Leave and free the Room by name
AddPlaybackComponent	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
GetOrCreateMicrophoneStream	Returns the attached Audio
RoomsSetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in each room
RoomsUpdatePosition	Updates the two-dimensional position of our own peer in each room
UpdateUserData	Updates the Rooms
GetRoom	Gets the room object from Odin
GetPeer	Gets the a Peer object from a specified room matching a peer ID
GetMedia	Get the PlaybackStream of a peer in the room
GetPeers	Get all remote peers inside a room
BroadcastMessage	Sends arbitrary data to a all remote peers in all rooms
GetPlaybackComponents	Gets all Audio across all rooms
GetPlaybackComponent	Gets a Audio
DestroyPlaybackComponents	Destroys all Audio instances

`}),e.add({id:1895,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/",title:"OdinHandler",section:"ODIN Documentation",description:" The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes. ",content:`

public class OdinHandler : MonoBehaviour

Discussion

The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes.

You can access the global singleton instance with the Instance property.

Properties

Name	Description
HasConnections	True if any Room is joined
Microphone	Unity Component that handles one Microphone where data gets routed through (n) Media
Rooms
OnRoomJoin	Called before an actual room join
OnRoomJoined	Called after a room is joined successfully
OnRoomLeave	Called before a room leave
OnRoomLeft	Called after a room is destroyed
OnPeerJoined	Called on every Peer that joins the room(s) we're connected to
OnPeerUserDataChanged	Called on every Peer that updates his UserData in the same room(s)
OnPeerLeft	Called on every Peer that left in the same room(s)
OnMediaAdded	Called on every Peer that created a media in the same room(s)
OnMediaRemoved	Called on every Peer that closed/destroyed one of his own media in the same room(s)
OnMediaActiveStateChanged	Called on every activity change of a media in the same room(s)
OnRoomUserDataChanged	Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.
OnMessageReceived	Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem
OnConnectionStateChanged	Called on the Room that changed the connection state
OnCreatedMediaObject	Called if this OdinHandler created a MediaStream that was requested by the MediaQueue
OnDeleteMediaObject	Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue
UnityAudioSourceTag	Identify by Unity-Tag to attach a Audio
Use3DAudio	Enable 3D Audio via preset Odin
CreatePlayback	Creates Room_OnMediaAdded(System events
PlaybackAudioMixer
PlaybackAudioMixerGroup

Static Properties

Name	Description
Config	Static reference to the global Unity
Instance	Singleton reference to this OdinHandler

Public Methods

Name	Description
GetUserData
JoinRoom	Join or create a room by name and attach a Media
LeaveRoom	Leave and free the Room by name
AddPlaybackComponent	Tries to identifiy a gameobject by tag to assign the PlaybackComponent
GetOrCreateMicrophoneStream	Returns the attached Audio
RoomsSetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in each room
RoomsUpdatePosition	Updates the two-dimensional position of our own peer in each room
UpdateUserData	Updates the Rooms
GetRoom	Gets the room object from Odin
GetPeer	Gets the a Peer object from a specified room matching a peer ID
GetMedia	Get the PlaybackStream of a peer in the room
GetPeers	Get all remote peers inside a room
BroadcastMessage	Sends arbitrary data to a all remote peers in all rooms
GetPlaybackComponents	Gets all Audio across all rooms
GetPlaybackComponent	Gets a Audio
DestroyPlaybackComponents	Destroys all Audio instances

`}),e.add({id:1896,href:"https://www.4players.io/odin/sdk/nodejs/types/odinjoinedevent/",title:"OdinJoinedEvent",section:"ODIN Documentation",description:"",content:`

type OdinJoinedEvent = (event: OdinJoinedEventPayload)

Parameters

Name	Type	Description
event	OdinJoinedEventPayload

`}),e.add({id:1897,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/",title:"OdinJoinedEventPayload",section:"ODIN Documentation",description:"The payload for the Joined event.",content:`

export interface OdinJoinedEventPayload

The payload for the Joined event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
ownPeerId	number	The ID of the local peer.
ownUserId	string	The ID of the local user. It is the same as the user id that was passed to join.
roomId	string	The ID of the room that was joined. It’s the same as the room id that was passed to join.
roomUserData	undefined \| Uint8Array	The current user data of the room
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1898,href:"https://www.4players.io/odin/sdk/nodejs/types/odinleftevent/",title:"OdinLeftEvent",section:"ODIN Documentation",description:"",content:`

type OdinLeftEvent = (event: OdinLeftEventPayload)

Parameters

Name	Type	Description
event	OdinLeftEventPayload

`}),e.add({id:1899,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinlefteventpayload/",title:"OdinLeftEventPayload",section:"ODIN Documentation",description:"The payload for the Left event.",content:`

export interface OdinLeftEventPayload

The payload for the Left event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
roomId	string	The ID of the room that was left. It’s the same as the room id that was passed to join.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1900,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static class OdinLibrary

Main lib entry class

Static Properties

Name	Type	Description
IsInitialized	Boolean	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	String	Location of the native ODIN runtime binary
Platform	SupportedPlatform	Platform the library is running on

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:1901,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

public static class OdinLibrary

Main lib entry class

Static Properties

Name	Type	Description
IsInitialized	Boolean	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	String	Location of the native ODIN runtime binary
Platform	SupportedPlatform	Platform the library is running on

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:1902,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

public static class OdinLibrary

Main lib entry class

Static Properties

Name	Type	Description
IsInitialized	Boolean	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	String	Location of the native ODIN runtime binary
Platform	SupportedPlatform	Platform the library is running on

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:1903,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

public static class OdinLibrary

Main lib entry class

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

Static Properties

Name	Description
IsInitialized	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	Location of the native ODIN runtime binary
Platform	Platform the library is running on

`}),e.add({id:1904,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

public static class OdinLibrary

Main lib entry class

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

Static Properties

Name	Description
IsInitialized	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	Location of the native ODIN runtime binary
Platform	Platform the library is running on

`}),e.add({id:1905,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/",title:"OdinLibrary",section:"ODIN Documentation",description:" Main lib entry class ",content:`

public static class OdinLibrary

Main lib entry class

Static Methods

Name	Description
Initialize	Initializes the native ODIN runtime
Release	Releases the unmanaged resources used by the Core-Instance

Static Properties

Name	Description
IsInitialized	Indicates whether or not the native ODIN runtime has been loaded and initialized
NativeBinary	Location of the native ODIN runtime binary
Platform	Platform the library is running on

`}),e.add({id:1906,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Properties

Name	Type	Description
PossibleNativeBinaryLocations	String[]	Possible install location of the native ODIN runtime binary
Platform	SupportedPlatform	Determines which platform specific code needs to be executed

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

`}),e.add({id:1907,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Properties

Name	Type	Description
PossibleNativeBinaryLocations	String[]	Possible install location of the native ODIN runtime binary
Platform	SupportedPlatform	Determines which platform specific code needs to be executed

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

`}),e.add({id:1908,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Properties

Name	Type	Description
PossibleNativeBinaryLocations	String[]	Possible install location of the native ODIN runtime binary
Platform	SupportedPlatform	Determines which platform specific code needs to be executed

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

`}),e.add({id:1909,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Constructors

Name	Description
OdinLibraryParameters()	Creates a new Core-Object.
OdinLibraryParameters(String)	Creates a new Core-Object.
OdinLibraryParameters(String, SupportedPlatform)	Creates a new Core-Object.

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

Properties

Name	Description
PossibleNativeBinaryLocations	Possible install location of the native ODIN runtime binary
Platform	Determines which platform specific code needs to be executed

`}),e.add({id:1910,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Constructors

Name	Description
OdinLibraryParameters()	Creates a new Core-Object.
OdinLibraryParameters(String)	Creates a new Core-Object.
OdinLibraryParameters(String, SupportedPlatform)	Creates a new Core-Object.

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

Properties

Name	Description
PossibleNativeBinaryLocations	Possible install location of the native ODIN runtime binary
Platform	Determines which platform specific code needs to be executed

`}),e.add({id:1911,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/",title:"OdinLibraryParameters",section:"ODIN Documentation",description:" A set of values that are used when initializing the native ODIN runtime ",content:`

public class OdinLibraryParameters

A set of values that are used when initializing the native ODIN runtime

Constructors

Name	Description
OdinLibraryParameters()	Creates a new Core-Object.
OdinLibraryParameters(String)	Creates a new Core-Object.
OdinLibraryParameters(String, SupportedPlatform)	Creates a new Core-Object.

Static Methods

Name	Description
TryGetNativeBinaryName	Returns the name of the native ODIN runtime binary that fits the current environment

Properties

Name	Description
PossibleNativeBinaryLocations	Possible install location of the native ODIN runtime binary
Platform	Determines which platform specific code needs to be executed

`}),e.add({id:1912,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/constructor_0/",title:"OdinLibraryParameters()",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters()

Creates a new Core-Object.

`}),e.add({id:1913,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/constructor_0/",title:"OdinLibraryParameters()",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters()

Creates a new Core-Object.

`}),e.add({id:1914,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/constructor_0/",title:"OdinLibraryParameters()",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters()

Creates a new Core-Object.

`}),e.add({id:1915,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/constructor_2/",title:"OdinLibraryParameters(String, SupportedPlatform)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string nativeBinaryLocation, SupportedPlatform platform)

Creates a new Core-Object.

Parameters

Name	Description
nativeBinaryLocation	Location to the Aki library binary.
platform	Determines which platform specific code will be executed.

`}),e.add({id:1916,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/constructor_2/",title:"OdinLibraryParameters(String, SupportedPlatform)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string nativeBinaryLocation, SupportedPlatform platform)

Creates a new Core-Object.

Parameters

Name	Description
nativeBinaryLocation	Location to the Aki library binary.
platform	Determines which platform specific code will be executed.

`}),e.add({id:1917,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/constructor_2/",title:"OdinLibraryParameters(String, SupportedPlatform)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string nativeBinaryLocation, SupportedPlatform platform)

Creates a new Core-Object.

Parameters

Name	Description
nativeBinaryLocation	Location to the Aki library binary.
platform	Determines which platform specific code will be executed.

`}),e.add({id:1918,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/constructor_1/",title:"OdinLibraryParameters(String)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string odinBinaryFolder)

Creates a new Core-Object.

Parameters

Name	Description
odinBinaryFolder	location where the native Aki sdk files can be found.

`}),e.add({id:1919,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/constructor_1/",title:"OdinLibraryParameters(String)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string odinBinaryFolder)

Creates a new Core-Object.

Parameters

Name	Description
odinBinaryFolder	location where the native Aki sdk files can be found.

`}),e.add({id:1920,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/constructor_1/",title:"OdinLibraryParameters(String)",section:"ODIN Documentation",description:"",content:`

public OdinLibraryParameters(string odinBinaryFolder)

Creates a new Core-Object.

Parameters

Name	Description
odinBinaryFolder	location where the native Aki sdk files can be found.

`}),e.add({id:1921,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/",title:"OdinMedia",section:"ODIN Documentation",description:"The OdinMedia class. Represents a local media stream added to the room - i.e. a microphone, another audio stream like files. Don't create OdinMedia instances directly, use `createAudioStream` from OdinRoom instead.",content:`

export class OdinMedia

The OdinMedia class. Represents a local media stream added to the room - i.e. a microphone, another audio stream like files. Don’t create OdinMedia instances directly, use createAudioStream from OdinRoom instead.

Constructor

Name	Type	Description
constructor	OdinMedia	Creates a new instance of a media object. Don’t create OdinMedia directly, use `createAudioStream` from OdinRoom instead.

Properties

Name	Type	Description
id	string	Gets the ID of the media.

Public Methods

Name	Type	Description
close	void	Closes the local audio stream and removed the media from the room
pause	void	Instructs the server to pause the media object, ceasing the reception of data. This operation essentially communicates a server-side mute request from the client, thus indicating a desire to halt packet reception for this media stream.
resume	void	Instructs the server to resume the media object, resuming the reception of data. This operation essentially communicates a server-side unmute request from the client, thus indicating a desire to resume packet reception for this media stream.
sendAudioData	void	Sends audio data to the room. The data must be in the format specified when creating the media as a 32-bit float array. Samples need to be between -1 and 1. Audio data needs to be sent in regular intervals, otherwise the audio will be sound interrupted. See the example for more details.

`}),e.add({id:1922,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/",title:"OdinMedia",section:"ODIN Documentation",description:" Wrapper class of for Unity (require AudioSource) This convenient class provides predefined helper functions to cover for a default usecases where the voice chat needs to work with AudioSource, AudioClip, AudioMixer, ... Default Unity GameObject altering functions: Add to the current GameObjectAdd to the current GameObjectAdd to the current GameObjectAdd to the current GameObject ",content:`

public class OdinMedia : MonoBehaviour, IMedia

Wrapper class of Odin for Unity (require AudioSource)

This convenient class provides predefined helper functions to cover for a default usecases where the voice chat needs to work with AudioSource, AudioClip, AudioMixer, ...

Default Unity GameObject altering functions:

OdinMediaAdd OdinMuteAudioComponent to the current GameObject

Properties

Name	Description
Playback	Actual Unity audio output component
OutSampleRate
OutChannels	Gets the current speaker mode. Default is 2 channel stereo.
Parent
Id
MediaDecoder	Media reference
AudioMixerGroup	Unity mixer
SpatialBlend	Property of AudioSource
RolloffMode	Property of AudioSource
MinDistance	Property of AudioSource
MaxDistance	Property of AudioSource
Activity	Media activity state flag
OnActiveStateChanged	Trigger on Activity changed
AutoDestroyAudioSource	Flag for destroy Playback linked AudioSource
AutoDestroyMediaStream	Flag for dispose of MediaDecoder

Public Methods

Name	Description
GetPipeline
AddApm
AddVad
AddVolumeBoost
AddMute
AddEffect
SetDecoder
ReadOdinAudioData
GetFrameBufferSize
CheckResetFrameBuffer
SetAudioSourcePtich
SetAudioClipData

`}),e.add({id:1923,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/",title:"OdinMedia",section:"ODIN Documentation",description:"Class describing a single media stream inside an `OdinRoom`.",content:`

export class OdinMedia

Class describing a single media stream inside an OdinRoom.

Properties

Name	Type	Description
active	boolean	Indicates wether or not the media is currently sending/receiving data.
id	number	The ID of the media.
paused	boolean	Indicates wether or not the media is paused.
peerId	number	The ID of the peer that owns the media.
remote	boolean	Indicates wether or not the media belongs to a remote peer.
started	boolean	Indicates whether or not the media is registered in the audio service instance (e.g. started).
volume	number	The individual playback volume of the media stream.

Public Methods

Name	Type	Description
addEventListener	void	Registers to media events from `IOdinMediaEvents`.
changeVolume	void	Changes the playback volume of the media.
pause	Promise<void>	Paused the media stream on the server to stop receiving data on it.
resume	Promise<void>	Paused the media stream on the server to start receiving data on it.
start	Promise<void>	Starts the media stream by initiating the encoder/decoder and adding it to the room if it belongs to the local peer.
stop	Promise<void>	Stops the media stream by terminating the encoder/decoder and removing it from the room if it belongs to the local peer.

`}),e.add({id:1924,href:"https://www.4players.io/odin/sdk/web/types/odinmediaactivitychangedevent/",title:"OdinMediaActivityChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMediaActivityChangedEvent = (event: IOdinEvent<IOdinMediaActivityChangedEventPayload>)

Discussion

The OdinMediaActivityChangedEvent event is emitted on OdinRoom , OdinPeer and OdinMedia instances when a media is sending/receiving data. This can be used to determine when a user starts/stops speaking.

Events are inheriting from IOdinEvent and provide an object described by IOdinMediaActivityChangedEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents
IOdinPeerEvents
IOdinMediaEvents

Example

OdinMediaActivityChangedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Listen to media started events in the room and start decoding its voice packets
  odinRoom.addEventListener('MediaStarted', (event) => {
    event.payload.media.start();
  });

  // Listen to media stopped events in the room and stop decoding its voice packets
  odinRoom.addEventListener('MediaStopped', (event) => {
    event.payload.media.stop();
  });

  // Listen to activity events of started medias in the room (e.g. someone is talking)
  odinRoom.addEventListener('MediaActivity', (event) => {
    console.log(\`Media \${event.payload.media.id} activity updated:\`, event.payload.media.active);
  });

  // Join the room
  odinRoom.join();

  // Create a new audio stream for our default capture device and append it to the room
  navigator.mediaDevices.getUserMedia({ audio: true }).then((mediaStream) => {
    odinRoom.createMedia(mediaStream);
  });
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinMediaActivityChangedEventPayload>

`}),e.add({id:1925,href:"https://www.4players.io/odin/sdk/nodejs/types/odinmediaactivityevent/",title:"OdinMediaActivityEvent",section:"ODIN Documentation",description:"",content:`

type OdinMediaActivityEvent = (event: OdinMediaActivityEventPayload)

Parameters

Name	Type	Description
event	OdinMediaActivityEventPayload

`}),e.add({id:1926,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaactivityeventpayload/",title:"OdinMediaActivityEventPayload",section:"ODIN Documentation",description:"The payload for the MediaActivity event.",content:`

export interface OdinMediaActivityEventPayload

The payload for the MediaActivity event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
mediaId	number	The ID of the media that changed the activity.
peerId	number	The ID of the peer that changed the media activity.
state	boolean	Indicates if the media is currently active or not (i.e. user talking or not).
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1927,href:"https://www.4players.io/odin/sdk/nodejs/types/odinmediaaddedevent/",title:"OdinMediaAddedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMediaAddedEvent = (event: OdinMediaAddedEventPayload)

Parameters

Name	Type	Description
event	OdinMediaAddedEventPayload

`}),e.add({id:1928,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaaddedeventpayload/",title:"OdinMediaAddedEventPayload",section:"ODIN Documentation",description:"The payload for the MediaAdded event.",content:`

export interface OdinMediaAddedEventPayload

The payload for the MediaAdded event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
mediaId	number	The ID of the media that was added.
peerId	number	The ID of the peer that added the media.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1929,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinmediaconfig/",title:"OdinMediaConfig",section:"ODIN Documentation",description:" ODIN audio stream configuration ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinMediaConfig

ODIN audio stream configuration

Properties

Name	Type	Description
SampleRate	MediaSampleRate	The number audio samples carried per second in Hz
Channels	MediaChannels	The number of audio channels

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1930,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinmediaconfig/",title:"OdinMediaConfig",section:"ODIN Documentation",description:" ODIN audio stream configuration ",content:`

public class OdinMediaConfig

ODIN audio stream configuration

Properties

Name	Type	Description
SampleRate	MediaSampleRate	The number audio samples carried per second in Hz
Channels	MediaChannels	The number of audio channels

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1931,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinmediaconfig/",title:"OdinMediaConfig",section:"ODIN Documentation",description:" ODIN audio stream configuration ",content:`

public class OdinMediaConfig

ODIN audio stream configuration

Properties

Name	Type	Description
SampleRate	MediaSampleRate	The number audio samples carried per second in Hz
Channels	MediaChannels	The number of audio channels

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1932,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinmediaconfig/",title:"OdinMediaConfig",section:"ODIN Documentation",description:" ODIN audio stream configuration ",content:`

public class OdinMediaConfig

ODIN audio stream configuration

Constructors

Name	Description
OdinMediaConfig(MediaSampleRate, MediaChannels)	MediaConfig for Media

Properties

Name	Description
SampleRate	The number audio samples carried per second in Hz
Channels	The number of audio channels

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1933,href:"https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig/",title:"OdinMediaConfig",section:"ODIN Documentation",description:" ODIN audio stream configuration ",content:`

public class OdinMediaConfig

ODIN audio stream configuration

Constructors

Name	Description
OdinMediaConfig(MediaSampleRate, MediaChannels)	MediaConfig for Media

Properties

Name	Description
SampleRate	The number audio samples carried per second in Hz
Channels	The number of audio channels

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1934,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinmediaconfig/constructor_0/",title:"OdinMediaConfig(MediaSampleRate, MediaChannels)",section:"ODIN Documentation",description:"",content:`

public OdinMediaConfig(MediaSampleRate rate, MediaChannels channels)

MediaConfig for Media

Parameters

Name	Description
rate	stream samplerate
channels	stream channels

`}),e.add({id:1935,href:"https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig/constructor_0/",title:"OdinMediaConfig(MediaSampleRate, MediaChannels)",section:"ODIN Documentation",description:"",content:`

public OdinMediaConfig(MediaSampleRate rate, MediaChannels channels)

MediaConfig for Media

Parameters

Name	Description
rate	stream samplerate
channels	stream channels

`}),e.add({id:1936,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/",title:"OdinMediaData",section:"ODIN Documentation",description:"",content:`

public class OdinMediaData : IDisposable

Static Methods

Name	Description
Create

Properties

Name	Description
AudioData
IsSilent
SamplesCount

Public Methods

Name	Description
GetSamples
SetSamples
CalculateRmsDbfs
Dispose

`}),e.add({id:1937,href:"https://www.4players.io/odin/sdk/nodejs/types/odinmediaremovedevent/",title:"OdinMediaRemovedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMediaRemovedEvent = (event: OdinMediaRemovedEventPayload)

Parameters

Name	Type	Description
event	OdinMediaRemovedEventPayload

`}),e.add({id:1938,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaremovedeventpayload/",title:"OdinMediaRemovedEventPayload",section:"ODIN Documentation",description:"The payload for the MediaRemoved event.",content:`

export interface OdinMediaRemovedEventPayload

The payload for the MediaRemoved event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
mediaId	number	The ID of the media that was removed.
peerId	number	The ID of the peer that removed the media.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1939,href:"https://www.4players.io/odin/sdk/web/types/odinmediastartedstoppedevent/",title:"OdinMediaStartedStoppedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMediaStartedStoppedEvent = (event: IOdinEvent<IOdinMediaStartedStoppedEventPayload>)

Discussion

The OdinMediaStartedStoppedEvent event is emitted on OdinRoom and OdinPeer instances whenever a remote peer started/stopped a media in the room. Usually, you would want to call the start or stop method on such media to start/stop the Opus decoder for audio playback.

Events are inheriting from IOdinEvent and provide an object described by IOdinMediaStartedStoppedEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents
IOdinPeerEvents

Example

OdinMediaStartedStoppedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Listen to media started events in the room and start decoding its voice packets
  odinRoom.addEventListener('MediaStarted', (event) => {
    console.log(\`Peer \${event.payload.peer.id} added a new media stream to the room\`);
    event.payload.media.start();
  });

  // Listen to media stopped events in the room and stop decoding its voice packets
  odinRoom.addEventListener('MediaStopped', (event) => {
    console.log(\`Peer \${event.payload.peer.id} removed a media stream from the room\`);
    event.payload.media.stop();
  });

  // Listen to activity events of started medias in the room (e.g. someone is talking)
  odinRoom.addEventListener('MediaActivity', (event) => {
    console.log(\`Media \${event.payload.media.id} activity updated:\`, event.payload.media.active);
  });

  // Join the room
  odinRoom.join();

  // Create a new audio stream for our default capture device and append it to the room
  navigator.mediaDevices.getUserMedia({ audio: true }).then((mediaStream) => {
    odinRoom.createMedia(mediaStream);
  });
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinMediaStartedStoppedEventPayload>

`}),e.add({id:1940,href:"https://www.4players.io/odin/sdk/nodejs/types/odinmessagereceivedevent/",title:"OdinMessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMessageReceivedEvent = (event: OdinMessageReceivedEventPayload)

Parameters

Name	Type	Description
event	OdinMessageReceivedEventPayload

`}),e.add({id:1941,href:"https://www.4players.io/odin/sdk/web/types/odinmessagereceivedevent/",title:"OdinMessageReceivedEvent",section:"ODIN Documentation",description:"",content:`

type OdinMessageReceivedEvent = (event: IOdinEvent<IOdinMessageReceivedEventPayload>)

Discussion

The OdinMessageReceivedEvent event is emitted on OdinRoom and OdinPeer instances when receiving a message from another peer in the room. Note that this event only provides the ID of the peer as senderId. This is because the invoking peer might not be in proximity due to server-side culling.

Events are inheriting from IOdinEvent and provide an object described by IOdinMessageReceivedEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents
IOdinPeerEvents

Example

OdinMessageReceivedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Get notified when a message with arbitrary data was received (data is encoded as Uint8Array)
  odinRoom.addEventListener('MessageReceived', (event) => {
    console.log(\`Received data from peer \${event.payload.senderId}:\`, event.payload.message);
  });

  // Join the room
  odinRoom.join();
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinMessageReceivedEventPayload>

`}),e.add({id:1942,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmessagereceivedeventpayload/",title:"OdinMessageReceivedEventPayload",section:"ODIN Documentation",description:"The payload for the MessageReceived event.",content:`

export interface OdinMessageReceivedEventPayload

The payload for the MessageReceived event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
messageData	Uint8Array	The message data received from the peer.
peerId	number	The ID of the peer that sent the message.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1943,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/",title:"OdinMicrophoneReader",section:"ODIN Documentation",description:" Handles microphone input data and sends input to ODIN This convenient class gathers input audio data from Unity managed Microphone to pass the data with event to other components. ",content:`

public class OdinMicrophoneReader : MonoBehaviour

Handles microphone input data and sends input to ODIN

This convenient class gathers input audio data from Unity managed Microphone to pass the data with OdinMicrophoneReader event to other components.

Properties

Name	Description
HasPermission	Check if the user has authorized use of the microphone
RedirectCapturedAudio	Skips registered PushAudio for the OnMicrophoneData event
SilenceCapturedAudio	Zero out the event audio buffer for PushAudio.
ContinueRecording
Samplerate
CustomInputDevice	Enable/Disable the use of InputDevice as a new/fixed device name
InputDevice	The device name to use as microphone in Unity. (i.e Microphone.Start )
AutostartListen	Use UnityEngine.Microphone.Start (Microphone.Start) in OdinMicrophoneReader
CustomMicVolumeScale
MicVolumeScale
OnAudioData
MicrophoneSamplerate
MicrophoneChannels
OnMicrophoneData	Event is fired if raw microphone data is available

Public Methods

Name	Description
StartListen	Start Unity microphone capture
StopListen	Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:1944,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmuteaudiocomponent/",title:"OdinMuteAudioComponent",section:"ODIN Documentation",description:" Custom mute audio component for This class is a effect in the odin audio pipline to mute based on the flag. The intention is to provide a convenient way with Unity Editor UI of Marshal a 1-byte signed integer bool for a specific audio packet in the current pipline. ",content:`

Inherits from:

public class OdinMuteAudioComponent : OdinCustomEffectUnityComponentBase<IntPtr>, IOdinEffect

Custom mute audio component for Media

This class is a effect in the odin audio pipline to mute based on the OdinMuteAudioComponent flag. The intention is to provide a convenient way with Unity Editor UI of Marshal a 1-byte signed integer bool for a specific audio packet in the current pipline.

Properties

Name	Description
SilenceToggle

Public Methods

Name	Description
GetEffectUserData
CustomEffectCallback

`}),e.add({id:1945,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/odinnoisesuppression/",title:"OdinNoiseSuppression",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression. A higher level will reduce the noise level at the expense of a higher speech distortion. ",content:`

public enum OdinNoiseSuppression

Valid levels for aggressiveness of the noise suppression. A higher level will reduce the noise level at the expense of a higher speech distortion.

Properties

Name	Description
ODIN_NOISE_SUPPRESSION_NONE	Noise suppression is disabled
ODIN_NOISE_SUPPRESSION_LOW	Use low suppression (6 dB)
ODIN_NOISE_SUPPRESSION_MODERATE	Use moderate suppression (12 dB)
ODIN_NOISE_SUPPRESSION_HIGH	Use high suppression (18 dB)
ODIN_NOISE_SUPPRESSION_VERY_HIGH	Use very high suppression (21 dB)

`}),e.add({id:1946,href:"https://www.4players.io/odin/sdk/nodejs/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:"Noise suppression levels",content:`

export enumeration OdinNoiseSuppressionLevel

Noise suppression levels

Name	Value	Description

`}),e.add({id:1947,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Type	Description
None	OdinNoiseSuppressionLevel	None
Low	OdinNoiseSuppressionLevel	6dB
Moderate	OdinNoiseSuppressionLevel	12 dB
High	OdinNoiseSuppressionLevel	18 dB
VeryHigh	OdinNoiseSuppressionLevel	21 dB

`}),e.add({id:1948,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression ",content:`

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Type	Description
None	OdinNoiseSuppressionLevel	None
Low	OdinNoiseSuppressionLevel	6dB
Moderate	OdinNoiseSuppressionLevel	12 dB
High	OdinNoiseSuppressionLevel	18 dB
VeryHigh	OdinNoiseSuppressionLevel	21 dB

`}),e.add({id:1949,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression ",content:`

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Type	Description
None	OdinNoiseSuppressionLevel	None
Low	OdinNoiseSuppressionLevel	6dB
Moderate	OdinNoiseSuppressionLevel	12 dB
High	OdinNoiseSuppressionLevel	18 dB
VeryHigh	OdinNoiseSuppressionLevel	21 dB

`}),e.add({id:1950,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression ",content:`

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Description
None	None
Low	6dB
Moderate	12 dB
High	18 dB
VeryHigh	21 dB

`}),e.add({id:1951,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/",title:"OdinNoiseSuppressionLevel",section:"ODIN Documentation",description:" Valid levels for aggressiveness of the noise suppression ",content:`

public enum OdinNoiseSuppressionLevel

Valid levels for aggressiveness of the noise suppression

Properties

Name	Description
None	None
Low	6dB
Moderate	12 dB
High	18 dB
VeryHigh	21 dB

`}),e.add({id:1952,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/",title:"OdinPeer",section:"ODIN Documentation",description:" Wrapper class of for Unity This convenient class provides dispatching of events to Unity with passthrough as well as predefined helper functions to cover for a default usecases where the voice chat is visually and logical represented Unity gameobject that are manageable with the Unity editor. Default Unity GameObject altering event callback functions: Creates GameObject with component and attach mediaDestroy GameObject with component ",content:`

public class OdinPeer : MonoBehaviour, IPeer

Wrapper class of Odin for Unity

This convenient class provides dispatching of events to Unity with passthrough as well as predefined helper functions to cover for a default usecases where the voice chat is visually and logical represented Unity gameobject that are manageable with the Unity editor.

Default Unity GameObject altering event callback functions:

Unity component

Properties

Name	Description
Parent
OnMediaAdded	Additional event redirect from Unity
OnMediaRemoved	Additional event redirect from Unity
Id
UserId
UserData

Public Methods

Name	Description
GetBasePeer
GetRoomApi
Peer_MediaAdded	Event trigger to create a Unity component
AddMediaComponent	Create a Unity component
Peer_MediaRemoved	Event trigger to remove a Unity component
RemoveMediaComponent	Removes all child components with the same media id

`}),e.add({id:1953,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/",title:"OdinPeer",section:"ODIN Documentation",description:"Class describing a single peer inside an `OdinRoom`.",content:`

export class OdinPeer

Class describing a single peer inside an OdinRoom.

Properties

Name	Type	Description
data	Uint8Array	The arbitrary user data of the peer.
id	number	The ID of the peer.
medias	Map<number><OdinMedia>	A list of media instances owned by the peer.
remote	boolean	Indicates, whether the peer is a remote peer or not.
userId	string	The identifier of the peer.

Public Methods

Name	Type	Description
addEventListener	void	Registers to peer events from `IOdinPeerEvents`.
addMedia	void	Adds a media to the list of active medias and starts decoding.
createMedia	OdinMedia	Creates a local media, configures audio capture/playback and returns the new `OdinMedia` instance.
removeMedia	void	Removes a media from the list of active medias and stops decoding.
removeMediaById	void	Removes a media from the list of active medias by the given ID and stops decoding.
sendMessage	Promise<void>	Sends a message with arbitrary data to this peer.
startMedias	Promise<void>	Starts all active medias or a list of specific active medias.
stopMedias	Promise<void>	Stops all active medias or a list of specific active medias.
update	Promise<void>	Sends user data of the peer to the server.

`}),e.add({id:1954,href:"https://www.4players.io/odin/sdk/web/types/odinpeerdatachangedevent/",title:"OdinPeerDataChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinPeerDataChangedEvent = (event: IOdinEvent<IOdinPeerDataChangedEventPayload>)

Discussion

The OdinPeerDataChangedEvent event is emitted on OdinRoom and OdinPeer instances when the user data of a remote peer changed.

Events are inheriting from IOdinEvent and provide an object described by IOdinPeerDataChangedEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents
IOdinPeerEvents

Example

OdinPeerDataChangedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Adds an event listener to get notified whenever a remote peer updated its user data
  odinRoom.addEventListener('PeerUserDataChanged', (event) => {
    console.log('Updated remote peer user data received:', event.payload.peer.data);
  });

  // Join the room
  odinRoom.join();
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinPeerDataChangedEventPayload>

`}),e.add({id:1955,href:"https://www.4players.io/odin/sdk/nodejs/types/odinpeerjoinedevent/",title:"OdinPeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

type OdinPeerJoinedEvent = (event: OdinPeerJoinedEventPayload)

Parameters

Name	Type	Description
event	OdinPeerJoinedEventPayload

`}),e.add({id:1956,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/",title:"OdinPeerJoinedEventPayload",section:"ODIN Documentation",description:"The payload for the PeerJoined event.",content:`

export interface OdinPeerJoinedEventPayload

The payload for the PeerJoined event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
peerId	number	The ID of the peer that joined.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.
userData	undefined \| Uint8Array	The user data of the peer that joined.
userId	string	The ID of the user that joined.

`}),e.add({id:1957,href:"https://www.4players.io/odin/sdk/web/types/odinpeerjoinedleftevent/",title:"OdinPeerJoinedLeftEvent",section:"ODIN Documentation",description:"",content:`

type OdinPeerJoinedLeftEvent = (event: IOdinEvent<IOdinPeerJoinedLeftEventPayload>)

Discussion

The OdinPeerJoinedLeftEvent event is emitted on OdinRoom instances when a remote peer joins or leaves the room.

Events are inheriting from IOdinEvent and provide an object described by IOdinPeerJoinedLeftEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents

Example

OdinPeerJoinedLeftEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Adds an event listener to get notified when a new peer joined the room
  odinRoom.addEventListener('PeerJoined', (event) => {
    console.log('A peer joined the room:', event.payload.peer);
  });
  // Adds an event listener to get notified then a peer left the room
  odinRoom.addEventListener('PeerLeft', (event) => {
    console.log('A peer left the room:', event.payload.peer);
  });

  // Join the room
  odinRoom.join();
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinPeerJoinedLeftEventPayload>

`}),e.add({id:1958,href:"https://www.4players.io/odin/sdk/nodejs/types/odinpeerleftevent/",title:"OdinPeerLeftEvent",section:"ODIN Documentation",description:"",content:`

type OdinPeerLeftEvent = (event: OdinPeerLeftEventPayload)

Parameters

Name	Type	Description
event	OdinPeerLeftEventPayload

`}),e.add({id:1959,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerlefteventpayload/",title:"OdinPeerLeftEventPayload",section:"ODIN Documentation",description:"The payload for the PeerLeft event.",content:`

export interface OdinPeerLeftEventPayload

The payload for the PeerLeft event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
peerId	number	The ID of the peer that left.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:1960,href:"https://www.4players.io/odin/sdk/nodejs/types/odinpeeruserdatachangedevent/",title:"OdinPeerUserDataChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinPeerUserDataChangedEvent = (event: OdinPeerUserDataChangedEventPayload)

Parameters

Name	Type	Description
event	OdinPeerUserDataChangedEventPayload

`}),e.add({id:1961,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeeruserdatachangedeventpayload/",title:"OdinPeerUserDataChangedEventPayload",section:"ODIN Documentation",description:"The payload for the PeerUserDataChanged event.",content:`

export interface OdinPeerUserDataChangedEventPayload

The payload for the PeerUserDataChanged event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
peerId	number	The ID of the peer that changed the user data.
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.
userData	undefined \| Uint8Array	The new user data of the peer.

`}),e.add({id:1962,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpipelinehandle/",title:"OdinPipelineHandle",section:"ODIN Documentation",description:"",content:`

public class OdinPipelineHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1963,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/",title:"OdinRoom",section:"ODIN Documentation",description:"The OdinRoom class. Use createRoom from OdinClient instance to create a room. The OdinRoom requires a token to connect to a room. OdinClients handles token creation for you, so its easier to just use OdinClient for room creation. Typical procedure is to create an OdinClient instance with an access key and call its `createRoom` function to create a room with a name and for a user id. Then add event listeners to the room and call `join` to connect to the room.",content:`

export class OdinRoom

The OdinRoom class. Use createRoom from OdinClient instance to create a room. The OdinRoom requires a token to connect to a room. OdinClients handles token creation for you, so its easier to just use OdinClient for room creation. Typical procedure is to create an OdinClient instance with an access key and call its createRoom function to create a room with a name and for a user id. Then add event listeners to the room and call join to connect to the room.

Constructor

Name	Type	Description
constructor	OdinRoom	Creates a new instance of a room with a token. Use OdinClient if you don’t want to manage tokens yourself. Important: Don’t use this function directly, use OdinClient instead.

Properties

Name	Type	Description
id	string	Gets the ID of the room.
ownPeerId	number	Gets the ID of the local peer joined to the room.

Public Methods

Name	Type	Description
addEventListener	void	Adds an event listener to the room for specific events.
close	void	Closes the room and disconnects from the server.
createAudioStream	OdinMedia	Creates a local audio stream and adds it to the room. An OdinMedia object will be returned that allows you to send audio data.
join	void	Joins the room with the given gateway URL and optional user data.
removeEventListener	void	Removes an event listener from the room for specific events.
sendMessage	void	Sends a message to the room.
setEventListener	void	Sets a global event listener that received all events, this can be helpful for debugging. Please use addEventListener instead for production code.
setPositionScale	void	Sets the scaling factor for coordinates supplied to `updatePosition`, facilitating adaptation to your game’s unique coordinate system requirements. Peers are visible to each other only within a unit circle of radius `1.0`. When altering a peer’s position, ensure the position is scaled such that the maximum distance remains one or less. This scaling can be performed manually or by specifying the multiplicative scale here. Note: It’s crucial to maintain consistent scaling across all client applications.
updateOwnUserData	void	Updates the peer user data of the local peer
updatePosition	void	Updates the three-dimensional position of the current peer in this room. The server utilizes the provided coordinates to perform automatic culling among peers in the same room, based on unit circles with a radius of `1.0`. This feature is particularly beneficial in scenarios involving a large number of peers within the same room, enabling peers to interact or ‘see’ each other only when in close proximity. To modify the distance sensitivity for position updates, use `setPositionScale`. Note: Use this before calling `join` to set the initial peer position upon connect.

`}),e.add({id:1964,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/",title:"OdinRoom",section:"ODIN Documentation",description:" Wrapper class of for Unity. This convenient class provides dispatching of events to Unity with passthrough as well as predefined helper functions to cover for a default usecases where the voice chat is visually and logical represented Unity gameobject that are manageable with the Unity editor like Context menu, Inspector and/or Hierarchy window. Default Unity GameObject altering event callback functions: Creates GameObject with componentDestroy GameObject with componentDestroy this components GameObject if the connection is closed i.e cleanup ",content:`

public class OdinRoom : MonoBehaviour, IRoom

Wrapper class of Room for Unity.

Default Unity GameObject altering event callback functions:

ConnectionStatusState(SystemDestroy this components GameObject if the connection is closed i.e cleanup

Properties

Name	Description
Gateway	Odin endpoint server
Token	Odin room token
AudioMixerGroup	Unity mixer
Samplerate	Unity samplerate
IsStereo	Unity channel flag
Id	Odin room id
Parent	Default value gameObject parent or Unity root
OnRoomJoined
OnMediaAdded	Event OnMediaStarted redirected as Unity event
OnMediaRemoved	Event OnMediaStopped redirected as Unity event
OnPeerJoined	Event OnPeerJoined redirected as Unity event
OnPeerLeft	Event OnPeerLeft redirected as Unity event
OnMessageReceived	Event OnMessageReceived redirected as Unity event
OnConnectionStateChanged	Event OnConnectionStatusChanged redirected as Unity event

Public Methods

Name	Description
GetBaseRoom	Odin base room
PeerLeftRemoveComponent	Removes all child components with the same peer id
RemovePeerComponent	Remove a Unity from a gameobject
PeerJoinedCreateComponent	Add a new GameObject with a new Unity component
AddPeerComponent	Add Unity to a gameobject
ConnectionStatusState	Check status if the room should destroy the gameobject
ProxyAudio	Redirects audio to all media encoders in the corresponding room.
LinkInputMedia	Add a input media encoder to the corresponding room.
UnlinkInputMedia	Remove a input media encoder from the corresponding room.
ResumeOutputMedia	Start a stopped remote output decoder
PauseOutputMedia	Stop a started remote output decoder
WebRequestToken	Uses UnityWebRequest with POST data as json to get a response from a token-server

`}),e.add({id:1965,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/",title:"OdinRoom",section:"ODIN Documentation",description:"Class describing an `OdinRoom`.",content:`

export class OdinRoom

Class describing an OdinRoom.

Properties

Name	Type	Description
connectionState	OdinConnectionState	The current state of the room stream connection.
customer	string	The customer identifier this room is assigned to.
data	Uint8Array	The arbitrary user data of the room.
id	string	The ID of the room.
ownPeer	OdinPeer	An instance of your own `OdinPeer` in the room.
position	any	The current three-dimensional position of our own `OdinPeer` in the room.
remotePeers	Map<number><OdinPeer>	A map of all remote `OdinPeer` instances in the room using the peer ID as index.
serverAddress	string	The address of the voice server this room is living on.

Public Methods

Name	Type	Description
addEventListener	void	Register to peer events from `IOdinRoomEvents`.
changeMediaStream	Promise<void>	Changes the active capture stream (e.g. when switching to another input device).
changeVolume	void	Change the global master volume for the room (should be between 0 and 2).
createMedia	Promise<OdinMedia>	Creates a new local media using the specified stream.
disableVAD	void	Disables RNN-based voice activity detection.
disableVolumeGate	void	Disables RNN-based voice activity detection.
enableVAD	void	Enables RNN-based voice activity detection.
enableVolumeGate	void	Enables RNN-based voice activity detection.
flushOwnPeerDataUpdate	Promise<void>	Sends updated user data of your own peer to the server.
getAudioSettings	undefined \| IOdinAudioSettings	Returns the current voice processing config for VAD and volume gate.
getMediaById	undefined \| OdinMedia	Returns the `OdinMedia` instance matching the specified ID.
getPeerById	undefined \| OdinPeer	Returns the `OdinPeer` instance matching the specified ID.
join	Promise<OdinPeer>	Joins the room and returns your own peer instance after the room was successfully joined.
sendMessage	Promise<void>	Sends a message with arbitrary data to all peers in the room or optionally to a list of specified peers.
setPosition	void	Updates the three-dimensional position of our own `OdinPeer` in the room to apply server-side culling.
startVADMeter	void	Enables emitting of RNN-based voice activity detection statistics.
stopVADMeter	void	Disables emitting of RNN-based voice activity detection statistics.
updateVADThresholds	void	Updates thresholds for vice activity detection (between 0 and 1).
updateVolumeGateThresholds	void	Updates thresholds for the input volume gate (between -90 and 0).

`}),e.add({id:1966,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/",title:"OdinRoomConfig",section:"ODIN Documentation",description:" Audio processing configuration of an ODIN room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Properties

Name	Type	Description
VoiceActivityDetection	Boolean	Enables or disables voice activity detection (VAD)
VoiceActivityDetectionAttackProbability	Single	Voice probability value when the VAD should engage.
VoiceActivityDetectionReleaseProbability	Single	Voice probability value when the VAD should disengage after previously being engaged.
VolumeGate	Boolean	Enables or disables volume gate
VolumeGateAttackLoudness	Single	Root mean square power (dBFS) when the volume gate should engage.
VolumeGateReleaseLoudness	Single	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
EchoCanceller	Boolean	Enable or disable echo cancellation
HighPassFilter	Boolean	Enable or disable high pass filtering
PreAmplifier	Boolean	Enable or disable the pre amplifier
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Set the aggressiveness of the suppression
TransientSuppressor	Boolean	Enable or disable the transient suppressor

Public Methods

Name	Description
ToString	Debug

Static Methods

Name	Description
GetOdinDefault	Creates Apm OdinRoomConfig based on Odin

`}),e.add({id:1967,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/",title:"OdinRoomConfig",section:"ODIN Documentation",description:" Audio processing configuration of an ODIN room ",content:`

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Properties

Name	Type	Description
VoiceActivityDetection	Boolean	Enables or disables voice activity detection (VAD)
VoiceActivityDetectionAttackProbability	Single	Voice probability value when the VAD should engage.
VoiceActivityDetectionReleaseProbability	Single	Voice probability value when the VAD should disengage after previously being engaged.
VolumeGate	Boolean	Enables or disables volume gate
VolumeGateAttackLoudness	Single	Root mean square power (dBFS) when the volume gate should engage.
VolumeGateReleaseLoudness	Single	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
EchoCanceller	Boolean	Enable or disable echo cancellation
HighPassFilter	Boolean	Enable or disable high pass filtering
PreAmplifier	Boolean	Enable or disable the pre amplifier
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Set the aggressiveness of the suppression
TransientSuppressor	Boolean	Enable or disable the transient suppressor
GainController	Boolean	Enable or disable the gain controller

Public Methods

Name	Description
ToString	Debug

Static Methods

Name	Description
GetOdinDefault	Creates Apm OdinRoomConfig based on Odin

`}),e.add({id:1968,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/",title:"OdinRoomConfig",section:"ODIN Documentation",description:" Audio processing configuration of an ODIN room ",content:`

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Properties

Name	Type	Description
VoiceActivityDetection	Boolean	Enables or disables voice activity detection (VAD)
VoiceActivityDetectionAttackProbability	Single	Voice probability value when the VAD should engage.
VoiceActivityDetectionReleaseProbability	Single	Voice probability value when the VAD should disengage after previously being engaged.
VolumeGate	Boolean	Enables or disables volume gate
VolumeGateAttackLoudness	Single	Root mean square power (dBFS) when the volume gate should engage.
VolumeGateReleaseLoudness	Single	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
EchoCanceller	Boolean	Enable or disable echo cancellation
HighPassFilter	Boolean	Enable or disable high pass filtering
PreAmplifier	Boolean	Enable or disable the pre amplifier
NoiseSuppressionLevel	OdinNoiseSuppressionLevel	Set the aggressiveness of the suppression
TransientSuppressor	Boolean	Enable or disable the transient suppressor

Public Methods

Name	Description
ToString	Debug

Static Methods

Name	Description
GetOdinDefault	Creates Apm OdinRoomConfig based on Odin

`}),e.add({id:1969,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/",title:"OdinRoomConfig",section:"ODIN Documentation",description:" Audio processing configuration of an ODIN room ",content:`

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Constructors

Name	Description
OdinRoomConfig(Boolean, Single, Single, Boolean, Single, Single, Boolean, Boolean, Boolean, OdinNoiseSuppressionLevel, Boolean, Boolean)	Audio processing configuration of an ODIN room
OdinRoomConfig(IOdinApmConfig)	Audio processing configuration of an ODIN room

Static Methods

Name	Description
GetOdinDefault	Creates Apm OdinRoomConfig based on Odin

Properties

Name	Description
VoiceActivityDetection	Enables or disables voice activity detection (VAD)
VoiceActivityDetectionAttackProbability	Voice probability value when the VAD should engage.
VoiceActivityDetectionReleaseProbability	Voice probability value when the VAD should disengage after previously being engaged.
VolumeGate	Enables or disables volume gate
VolumeGateAttackLoudness	Root mean square power (dBFS) when the volume gate should engage.
VolumeGateReleaseLoudness	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
EchoCanceller	Enable or disable echo cancellation
HighPassFilter	Enable or disable high pass filtering
PreAmplifier	Enable or disable the pre amplifier
NoiseSuppressionLevel	Set the aggressiveness of the suppression
TransientSuppressor	Enable or disable the transient suppressor
GainController	Enable or disable the gain controller

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1970,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/",title:"OdinRoomConfig",section:"ODIN Documentation",description:" Audio processing configuration of an ODIN room ",content:`

public class OdinRoomConfig : IOdinApmConfig

Audio processing configuration of an ODIN room

Constructors

Name	Description
OdinRoomConfig(Boolean, Single, Single, Boolean, Single, Single, Boolean, Boolean, Boolean, OdinNoiseSuppressionLevel, Boolean, Boolean)	Audio processing configuration of an ODIN room
OdinRoomConfig(IOdinApmConfig)	Audio processing configuration of an ODIN room

Static Methods

Name	Description
GetOdinDefault	Creates Apm OdinRoomConfig based on Odin

Properties

Name	Description
VoiceActivityDetection	Enables or disables voice activity detection (VAD)
VoiceActivityDetectionAttackProbability	Voice probability value when the VAD should engage.
VoiceActivityDetectionReleaseProbability	Voice probability value when the VAD should disengage after previously being engaged.
VolumeGate	Enables or disables volume gate
VolumeGateAttackLoudness	Root mean square power (dBFS) when the volume gate should engage.
VolumeGateReleaseLoudness	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
EchoCanceller	Enable or disable echo cancellation
HighPassFilter	Enable or disable high pass filtering
PreAmplifier	Enable or disable the pre amplifier
NoiseSuppressionLevel	Set the aggressiveness of the suppression
TransientSuppressor	Enable or disable the transient suppressor
GainController	Enable or disable the gain controller

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:1971,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/constructor_0/",title:"OdinRoomConfig(Boolean, Single, Single, Boolean, Single, Single, Boolean, Boolean, Boolean, OdinNoiseSuppressionLevel, Boolean, Boolean)",section:"ODIN Documentation",description:"",content:`

public OdinRoomConfig(bool voiceActivityDetection = false, float voiceActivityDetectionAttackProbability = 0F, float voiceActivityDetectionReleaseProbability = 0F, bool volumeGate = false, float volumeGateAttackLoudness = 0F, float volumeGateReleaseLoudness = 0F, bool echoCanceller = false, bool highPassFilter = false, bool preAmplifier = false, OdinNoiseSuppressionLevel noiseSuppressionLevel = null, bool transientSuppressor = false, bool gainController = false)

Audio processing configuration of an ODIN room

Parameters

Name	Description
voiceActivityDetection	Enables or disables voice activity detection (VAD)
voiceActivityDetectionAttackProbability	Voice probability value when the VAD should engage.
voiceActivityDetectionReleaseProbability	Voice probability value when the VAD should disengage after previously being engaged.
volumeGate	Enables or disables volume gate
volumeGateAttackLoudness	Root mean square power (dBFS) when the volume gate should engage.
volumeGateReleaseLoudness	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
echoCanceller	Enable or disable echo cancellation
highPassFilter	Enable or disable high pass filtering
preAmplifier	Enable or disable the pre amplifier
noiseSuppressionLevel	Set the aggressiveness of the suppression
transientSuppressor	Enable or disable the transient suppressor
gainController	Enable or disable the gain controller

`}),e.add({id:1972,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/constructor_0/",title:"OdinRoomConfig(Boolean, Single, Single, Boolean, Single, Single, Boolean, Boolean, Boolean, OdinNoiseSuppressionLevel, Boolean, Boolean)",section:"ODIN Documentation",description:"",content:`

public OdinRoomConfig(bool voiceActivityDetection = false, float voiceActivityDetectionAttackProbability = 0F, float voiceActivityDetectionReleaseProbability = 0F, bool volumeGate = false, float volumeGateAttackLoudness = 0F, float volumeGateReleaseLoudness = 0F, bool echoCanceller = false, bool highPassFilter = false, bool preAmplifier = false, OdinNoiseSuppressionLevel noiseSuppressionLevel = null, bool transientSuppressor = false, bool gainController = false)

Audio processing configuration of an ODIN room

Parameters

Name	Description
voiceActivityDetection	Enables or disables voice activity detection (VAD)
voiceActivityDetectionAttackProbability	Voice probability value when the VAD should engage.
voiceActivityDetectionReleaseProbability	Voice probability value when the VAD should disengage after previously being engaged.
volumeGate	Enables or disables volume gate
volumeGateAttackLoudness	Root mean square power (dBFS) when the volume gate should engage.
volumeGateReleaseLoudness	Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.
echoCanceller	Enable or disable echo cancellation
highPassFilter	Enable or disable high pass filtering
preAmplifier	Enable or disable the pre amplifier
noiseSuppressionLevel	Set the aggressiveness of the suppression
transientSuppressor	Enable or disable the transient suppressor
gainController	Enable or disable the gain controller

`}),e.add({id:1973,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/constructor_1/",title:"OdinRoomConfig(IOdinApmConfig)",section:"ODIN Documentation",description:"",content:`

public OdinRoomConfig(IOdinApmConfig odinApm)

Audio processing configuration of an ODIN room

Parameters

Name	Description
odinApm	Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1974,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/constructor_1/",title:"OdinRoomConfig(IOdinApmConfig)",section:"ODIN Documentation",description:"",content:`

public OdinRoomConfig(IOdinApmConfig odinApm)

Audio processing configuration of an ODIN room

Parameters

Name	Description
odinApm	Interface for Audio processing configuration of an ODIN room

`}),e.add({id:1975,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstate/",title:"OdinRoomConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Type	Description
Connecting	OdinRoomConnectionState	Connection is being established
Connected	OdinRoomConnectionState	Connection is established
Disconnected	OdinRoomConnectionState	Connection is closed

`}),e.add({id:1976,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstate/",title:"OdinRoomConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Type	Description
Connecting	OdinRoomConnectionState	Connection is being established
Connected	OdinRoomConnectionState	Connection is established
Disconnected	OdinRoomConnectionState	Connection is closed

`}),e.add({id:1977,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstate/",title:"OdinRoomConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Type	Description
Connecting	OdinRoomConnectionState	Connection is being established
Connected	OdinRoomConnectionState	Connection is established
Disconnected	OdinRoomConnectionState	Connection is closed

`}),e.add({id:1978,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstate/",title:"OdinRoomConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Description
Connecting	Connection is being established
Connected	Connection is established
Disconnected	Connection is closed

`}),e.add({id:1979,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstate/",title:"OdinRoomConnectionState",section:"ODIN Documentation",description:" Connection state of the ODIN client ",content:`

public enum OdinRoomConnectionState

Connection state of the ODIN client

Properties

Name	Description
Connecting	Connection is being established
Connected	Connection is established
Disconnected	Connection is closed

`}),e.add({id:1980,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstatechangereason/",title:"OdinRoomConnectionStateChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Type	Description
ClientRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the user
ServerRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost	OdinRoomConnectionStateChangeReason	Connection state change was caused by a timeout

`}),e.add({id:1981,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstatechangereason/",title:"OdinRoomConnectionStateChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Type	Description
ClientRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the user
ServerRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost	OdinRoomConnectionStateChangeReason	Connection state change was caused by a timeout

`}),e.add({id:1982,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstatechangereason/",title:"OdinRoomConnectionStateChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Type	Description
ClientRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the user
ServerRequested	OdinRoomConnectionStateChangeReason	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost	OdinRoomConnectionStateChangeReason	Connection state change was caused by a timeout

`}),e.add({id:1983,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstatechangereason/",title:"OdinRoomConnectionStateChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Description
ClientRequested	Connection state change was initiated by the user
ServerRequested	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost	Connection state change was caused by a timeout

`}),e.add({id:1984,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstatechangereason/",title:"OdinRoomConnectionStateChangeReason",section:"ODIN Documentation",description:" Reason of connection state ",content:`

public enum OdinRoomConnectionStateChangeReason

Reason of connection state

Properties

Name	Description
ClientRequested	Connection state change was initiated by the user
ServerRequested	Connection state change was initiated by the server (e.g. peer was kicked)
ConnectionLost	Connection state change was caused by a timeout

`}),e.add({id:1985,href:"https://www.4players.io/odin/sdk/web/types/odinroomdatachangedevent/",title:"OdinRoomDataChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinRoomDataChangedEvent = (event: IOdinEvent<IOdinRoomDataChangedEventPayload>)

Discussion

The OdinRoomDataChangedEvent event is emitted on OdinRoom instances when the global user data of a room changed by a remote peer.

Events are inheriting from IOdinEvent and provide an object described by IOdinRoomDataChangedEventPayload in the payload property of the event.

Event Scopes

IOdinRoomEvents

Example

OdinRoomDataChangedEvent Example

import { OdinClient } from '@4players/odin';

const startOdin = async function (token: string) {
  // Authenticate using a token obtained externally and spawn a room instance
  const odinRoom = await OdinClient.initRoom(token);

  // Adds an event listener to get notified whenever a remote peer updated the global room user data
  odinRoom.addEventListener('UserDataChanged', (event) => {
    console.log('Updated room user data received:', event.payload.room.data);
  });

  // Join the room
  odinRoom.join();
};

startOdin('__YOUR TOKEN__').then(() => {
  console.log('Started ODIN');
});

Parameters

Name	Type	Description
event	IOdinEvent<IOdinRoomDataChangedEventPayload>

`}),e.add({id:1986,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroomhandle/",title:"OdinRoomHandle",section:"ODIN Documentation",description:"",content:`

public class OdinRoomHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1987,href:"https://www.4players.io/odin/sdk/web/types/odinroomjoinedleftevent/",title:"OdinRoomJoinedLeftEvent",section:"ODIN Documentation",description:"",content:`

type OdinRoomJoinedLeftEvent = (event: IOdinEvent<IOdinRoomJoinedLeftEventPayload>)

Discussion

The OdinRoomJoinedLeftEvent event is emitted internally when a room was joined/left. It is reserved for future use.

To get notifications about your own client joining/leaving a room, use the OdinConnectionStateChangedEvent event instead.

Event Scopes

IOdinRoomEvents

Parameters

Name	Type	Description
event	IOdinEvent<IOdinRoomJoinedLeftEventPayload>

`}),e.add({id:1988,href:"https://www.4players.io/odin/sdk/nodejs/types/odinroomuserdatachangedevent/",title:"OdinRoomUserDataChangedEvent",section:"ODIN Documentation",description:"",content:`

type OdinRoomUserDataChangedEvent = (event: OdinRoomUserDataChangedEventPayload)

Parameters

Name	Type	Description
event	OdinRoomUserDataChangedEventPayload

`}),e.add({id:1989,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinroomuserdatachangedeventpayload/",title:"OdinRoomUserDataChangedEventPayload",section:"ODIN Documentation",description:"The payload for the RoomUserDataChanged event.",content:`

export interface OdinRoomUserDataChangedEventPayload

The payload for the RoomUserDataChanged event.

Properties

Name	Type	Description
event	any	The name of the event that was fired (see keys of OdinEvents for possible values).
tag	number	An internal integer representing the type of the event. This is mainly used internally for testing purposes.
userData	undefined \| Uint8Array	The new user data of the room.

`}),e.add({id:1990,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinrpc/",title:"OdinRpc",section:"ODIN Documentation",description:"",content:`

public struct OdinRpc

Properties

Name	Description
bytes	byte[]
bytes_length

`}),e.add({id:1991,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinsensitivityconfig/",title:"OdinSensitivityConfig",section:"ODIN Documentation",description:"",content:`

public struct OdinSensitivityConfig

Properties

Name	Description
enabled
attack_threshold	when the trigger should engage
release_threshold	when the trigger should disengage

`}),e.add({id:1992,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/",title:"OdinTerrainFilterComponent",section:"ODIN Documentation",description:" Custom filter by terrain component for This class is a effect in the odin audio pipline to mute audio based on location of a GameObject relative to a terrain type in Unity space. Note that the default implementation is Unity specific on a 2D calculation with X, Z and is not useful in all occlusions. ",content:`

Inherits from:

public class OdinTerrainFilterComponent : OdinCustomEffectUnityComponentBase<TerrainFilterUserData>, IOdinEffect

Custom filter by terrain component for Media

This class is a effect in the odin audio pipline to mute audio based on location of a GameObject relative to a terrain type in Unity space. Note that the default implementation is Unity specific on a 2D calculation with X, Z and is not useful in all occlusions.

Properties

Name	Description
Emitter
Data

Public Methods

Name	Description
SetUserData	Set delegate userdata for effect callback
GetEffectUserData	Get delegate userdata
CustomEffectCallback

`}),e.add({id:1993,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odintokengeneratorhandle/",title:"OdinTokenGeneratorHandle",section:"ODIN Documentation",description:"",content:`

public class OdinTokenGeneratorHandle : SafeHandleZeroOrMinusOneIsInvalid

Properties

Name	Description
IsAlive

`}),e.add({id:1994,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinuserdatatarget/",title:"OdinUserDataTarget",section:"ODIN Documentation",description:" Supported targets for user data updates. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum OdinUserDataTarget

Supported targets for user data updates.

Properties

Name	Type	Description
OdinUserDataTarget_Peer	OdinUserDataTarget	Peer UserData
OdinUserDataTarget_Room	OdinUserDataTarget	Room UserData

`}),e.add({id:1995,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinuserdatatarget/",title:"OdinUserDataTarget",section:"ODIN Documentation",description:" Supported targets for user data updates. ",content:`

public enum OdinUserDataTarget

Supported targets for user data updates.

Properties

Name	Type	Description
OdinUserDataTarget_Peer	OdinUserDataTarget	Peer UserData
OdinUserDataTarget_Room	OdinUserDataTarget	Room UserData

`}),e.add({id:1996,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinuserdatatarget/",title:"OdinUserDataTarget",section:"ODIN Documentation",description:" Supported targets for user data updates. ",content:`

public enum OdinUserDataTarget

Supported targets for user data updates.

Properties

Name	Type	Description
OdinUserDataTarget_Peer	OdinUserDataTarget	Peer UserData
OdinUserDataTarget_Room	OdinUserDataTarget	Room UserData

`}),e.add({id:1997,href:"https://www.4players.io/odin/sdk/unity/enums/odinuserdatatarget/",title:"OdinUserDataTarget",section:"ODIN Documentation",description:" Supported targets for user data updates. ",content:`

public enum OdinUserDataTarget

Supported targets for user data updates.

Properties

Name	Type	Description
OdinUserDataTarget_Peer	OdinUserDataTarget	Peer UserData
OdinUserDataTarget_Room	OdinUserDataTarget	Room UserData

`}),e.add({id:1998,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinuserdatatarget/odinuserdatatarget_peer/",title:"OdinUserDataTarget_Peer",section:"ODIN Documentation",description:" Peer UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

OdinUserDataTarget_Peer = 0

Peer UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:1999,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinuserdatatarget/odinuserdatatarget_peer/",title:"OdinUserDataTarget_Peer",section:"ODIN Documentation",description:" Peer UserData ",content:`

OdinUserDataTarget_Peer = 0

Peer UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2e3,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinuserdatatarget/odinuserdatatarget_peer/",title:"OdinUserDataTarget_Peer",section:"ODIN Documentation",description:" Peer UserData ",content:`

OdinUserDataTarget_Peer = 0

Peer UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2001,href:"https://www.4players.io/odin/sdk/unity/enums/odinuserdatatarget/odinuserdatatarget_peer/",title:"OdinUserDataTarget_Peer",section:"ODIN Documentation",description:" Peer UserData ",content:`

OdinUserDataTarget_Peer = 0

Peer UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2002,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinuserdatatarget/odinuserdatatarget_room/",title:"OdinUserDataTarget_Room",section:"ODIN Documentation",description:" Room UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

OdinUserDataTarget_Room = 1

Room UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2003,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinuserdatatarget/odinuserdatatarget_room/",title:"OdinUserDataTarget_Room",section:"ODIN Documentation",description:" Room UserData ",content:`

OdinUserDataTarget_Room = 1

Room UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2004,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinuserdatatarget/odinuserdatatarget_room/",title:"OdinUserDataTarget_Room",section:"ODIN Documentation",description:" Room UserData ",content:`

OdinUserDataTarget_Room = 1

Room UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2005,href:"https://www.4players.io/odin/sdk/unity/enums/odinuserdatatarget/odinuserdatatarget_room/",title:"OdinUserDataTarget_Room",section:"ODIN Documentation",description:" Room UserData ",content:`

OdinUserDataTarget_Room = 1

Room UserData

Value Type

Type	Description
OdinUserDataTarget

`}),e.add({id:2006,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/",title:"OdinVadComponent",section:"ODIN Documentation",description:" VoiceActivity component for This class provides configuration for the native implemented voice detection. Supports speech recognition and/or a volume threshold. ",content:`

public class OdinVadComponent : MonoBehaviour, IOdinEffect

VoiceActivity component for Media

This class provides configuration for the native implemented voice detection. Supports speech recognition and/or a volume threshold.

Properties

Name	Description
Media
Effect
IsCreated
VoiceActivityEnabled
VoiceActivityAttackThreshold	Idicates the vad attack probability setting in NativeBindings
VoiceActivityReleaseThreshold	Idicates the vad release probability setting in NativeBindings
VolumeGateEnabled
VolumeGateAttackThreshold	Idicates the gate attack loudness setting in NativeBindings
VolumeGateReleaseThreshold	Idicates the gate release loudness setting in NativeBindings

Public Methods

Name	Description
UpdateConfig
ResetEffect
GetMedia
GetEffect

`}),e.add({id:2007,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinvadconfig/",title:"OdinVadConfig",section:"ODIN Documentation",description:"",content:`

public struct OdinVadConfig

Properties

Name	Description
voice_activity
volume_gate

`}),e.add({id:2008,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public const string OdinVersion = "1.0.0"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2009,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

public const string OdinVersion = "1.5.8"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2010,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

public const string OdinVersion = "1.6.0"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2011,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

public const string OdinVersion = "1.6.7"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2012,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

public const string OdinVersion = "1.0.0"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2013,href:"https://www.4players.io/odin/sdk/unity/classes/nativebindings/odinversion/",title:"OdinVersion",section:"ODIN Documentation",description:" ODIN_VERSION ",content:`

public const string OdinVersion = "1.6.7"

ODIN_VERSION

Value Type

Type	Description
String

`}),e.add({id:2014,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumeboostcomponent/",title:"OdinVolumeBoostComponent",section:"ODIN Documentation",description:" Custom volume scale component for This class is a effect in the odin audio pipline to scale each sample individually in the buffer. ",content:`

Inherits from:

public class OdinVolumeBoostComponent : OdinCustomEffectUnityComponentBase<IntPtr>, IOdinEffect

Custom volume scale component for Media

This class is a effect in the odin audio pipline to scale each sample individually in the buffer.

Properties

Name	Description
ExponentOfScale
Scale

Public Methods

Name	Description
CustomEffectCallback

`}),e.add({id:2015,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumecomponent/",title:"OdinVolumeComponent",section:"ODIN Documentation",description:" Custom volume component for . Recommend the use of AudioSource.volume or AudioMixer/AudioMixerGroup instead This class is a effect in the odin audio pipline to change audio buffers by amplify the volume level. ",content:`

Inherits from:

public class OdinVolumeComponent : OdinCustomEffectUnityComponentBase<IntPtr>, IOdinEffect

Custom volume component for Media. Recommend the use of AudioSource.volume or AudioMixer/AudioMixerGroup instead

This class is a effect in the odin audio pipline to change audio buffers by amplify the volume level.

Properties

Name	Description
Volume
Ldb

Public Methods

Name	Description
CustomEffectCallback

`}),e.add({id:2016,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/utility/ok/",title:"OK",section:"ODIN Documentation",description:" Representative ErrorCode for Ok. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public const uint OK = 0U

Representative ErrorCode for Ok.

Value Type

Type	Description
UInt32

`}),e.add({id:2017,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/utility/ok/",title:"OK",section:"ODIN Documentation",description:" Representative ErrorCode for Ok. ",content:`

public const uint OK = 0U

Representative ErrorCode for Ok.

Value Type

Type	Description
UInt32

`}),e.add({id:2018,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/utility/ok/",title:"OK",section:"ODIN Documentation",description:" Representative ErrorCode for Ok. ",content:`

public const uint OK = 0U

Representative ErrorCode for Ok.

Value Type

Type	Description
UInt32

`}),e.add({id:2019,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/utility/ok/",title:"OK",section:"ODIN Documentation",description:" Representative ErrorCode for Ok. ",content:`

public const uint OK = 0U

Representative ErrorCode for Ok.

Value Type

Type	Description
UInt32

`}),e.add({id:2020,href:"https://www.4players.io/odin/sdk/unity/classes/utility/ok/",title:"OK",section:"ODIN Documentation",description:" Representative ErrorCode for Ok. ",content:`

public const uint OK = 0U

Representative ErrorCode for Ok.

Value Type

Type	Description
UInt32

`}),e.add({id:2021,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinconnectionstatechangedeventpayload/oldstate/",title:"oldState",section:"ODIN Documentation",description:"Previous state of the connection.",content:`

OdinConnectionState

Previous state of the connection.

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2023,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/onaudiodata/",title:"OnAudioData",section:"ODIN Documentation",description:"",content:`

public UnityAudioData OnAudioData

Value Type

Type	Description
UnityAudioData

`}),e.add({id:2024,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/onaudiodata/",title:"OnAudioData",section:"ODIN Documentation",description:"",content:`

public UnityAudioData OnAudioData

Value Type

Type	Description
UnityAudioData

`}),e.add({id:2025,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Called on the Room that changed the connection state ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ConnectionStateChangedProxy OnConnectionStateChanged

Called on the Room that changed the connection state

Info

If the client loses connection every connected room sends this event. Reconnect can fail and run into a timeout consequently additional events can be delayed.

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2026,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Called on the Room that changed the connection state ",content:`

public ConnectionStateChangedProxy OnConnectionStateChanged

Called on the Room that changed the connection state

Info

If the client loses connection every connected room sends this event. Reconnect can fail and run into a timeout consequently additional events can be delayed.

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2027,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Called on the Room that changed the connection state ",content:`

public ConnectionStateChangedProxy OnConnectionStateChanged

Called on the Room that changed the connection state

Info

If the client loses connection every connected room sends this event. Reconnect can fail and run into a timeout consequently additional events can be delayed.

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2028,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Called on the Room that changed the connection state ",content:`

public ConnectionStateChangedProxy OnConnectionStateChanged

Called on the Room that changed the connection state

Info

If the client loses connection every connected room sends this event. Reconnect can fail and run into a timeout consequently additional events can be delayed.

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2029,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public ConnectionStateChangedProxy OnConnectionStateChanged

Event OnConnectionStatusChanged redirected as Unity event

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2030,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onconnectionstatechanged/",title:"OnConnectionStateChanged",section:"ODIN Documentation",description:" Called on the Room that changed the connection state ",content:`

public ConnectionStateChangedProxy OnConnectionStateChanged

Called on the Room that changed the connection state

Info

If the client loses connection every connected room sends this event. Reconnect can fail and run into a timeout consequently additional events can be delayed.

Value Type

Type	Description
ConnectionStateChangedProxy

`}),e.add({id:2031,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onconnectionstatuschangeddelegate/",title:"OnConnectionStatusChangedDelegate",section:"ODIN Documentation",description:" Odin connection status ",content:`

public delegate void OnConnectionStatusChangedDelegate(object sender, string connectionStatus);

Odin connection status

Parameters

Name	Type	Description
sender	Object	Room object
connectionStatus	String	string status

`}),e.add({id:2032,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/oncreatedmediaobject/",title:"OnCreatedMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler created a MediaStream that was requested by the MediaQueue ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UnityCreatedMediaObject OnCreatedMediaObject

Called if this OdinHandler created a MediaStream that was requested by the MediaQueue

Info

Invokes after OnMediaAdded

Value Type

Type	Description
UnityCreatedMediaObject

Discussion

Example

`}),e.add({id:2033,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/oncreatedmediaobject/",title:"OnCreatedMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler created a MediaStream that was requested by the MediaQueue ",content:`

public UnityCreatedMediaObject OnCreatedMediaObject

Called if this OdinHandler created a MediaStream that was requested by the MediaQueue

Info

Invokes after OnMediaAdded

Value Type

Type	Description
UnityCreatedMediaObject

Discussion

Example

`}),e.add({id:2034,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/oncreatedmediaobject/",title:"OnCreatedMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler created a MediaStream that was requested by the MediaQueue ",content:`

public UnityCreatedMediaObject OnCreatedMediaObject

Called if this OdinHandler created a MediaStream that was requested by the MediaQueue

Info

Invokes after OnMediaAdded

Value Type

Type	Description
UnityCreatedMediaObject

Discussion

Example

`}),e.add({id:2035,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/oncreatedmediaobject/",title:"OnCreatedMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler created a MediaStream that was requested by the MediaQueue ",content:`

public UnityCreatedMediaObject OnCreatedMediaObject

Called if this OdinHandler created a MediaStream that was requested by the MediaQueue

Info

Invokes after OdinHandler

Value Type

Type	Description
UnityCreatedMediaObject

Discussion

Example

`}),e.add({id:2036,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/oncreatedmediaobject/",title:"OnCreatedMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler created a MediaStream that was requested by the MediaQueue ",content:`

public UnityCreatedMediaObject OnCreatedMediaObject

Called if this OdinHandler created a MediaStream that was requested by the MediaQueue

Info

Invokes after OnMediaAdded

Value Type

Type	Description
UnityCreatedMediaObject

Discussion

Whenever a “user (in ODIN language it’s a peer) has joined a room and starts sending audio data (i.e. has activated the microphone) this event is triggered after OnMediaAdded .

You can respond to this event and call the AddPlaybackComponent function of the OdinHandler.Instance like shown in the example below.

Your callback function must have this structure and contains information about the room, peer and the media object.

public class UnityCreatedMediaObject : UnityEvent<string, ulong, int>;

Whenever this callback is triggered, imagine a new player comes in the arena and the game master needs to give him a Walky Talky so that he can listen and talk to the other players.

Example

OnCreatedMediaObject Example

private void OnCreatedMediaObject(string roomName, ulong peerId, ushort mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Find the players game object in the scene
    var peerContainer = FindPlayerForPeerId(peerId);

    // Add PlaybackComponent to new dummy PeerCube
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Some AudioSource test settings
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

`}),e.add({id:2037,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/ondatagram/",title:"OnDatagram",section:"ODIN Documentation",description:" Redirect of ",content:`

public DatagramProxy OnDatagram

Redirect of OnDatagram

Value Type

Type	Description
DatagramProxy

`}),e.add({id:2038,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/ondeletemediaobject/",title:"OnDeleteMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UnityDeleteMediaObject OnDeleteMediaObject

Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue

Info

Invokes after OnMediaRemoved

Value Type

Type	Description
UnityDeleteMediaObject

`}),e.add({id:2039,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/ondeletemediaobject/",title:"OnDeleteMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue ",content:`

public UnityDeleteMediaObject OnDeleteMediaObject

Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue

Info

Invokes after OnMediaRemoved

Value Type

Type	Description
UnityDeleteMediaObject

`}),e.add({id:2040,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/ondeletemediaobject/",title:"OnDeleteMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue ",content:`

public UnityDeleteMediaObject OnDeleteMediaObject

Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue

Info

Invokes after OnMediaRemoved

Value Type

Type	Description
UnityDeleteMediaObject

`}),e.add({id:2041,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/ondeletemediaobject/",title:"OnDeleteMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue ",content:`

public UnityDeleteMediaObject OnDeleteMediaObject

Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue

Info

Invokes after OdinHandler

Value Type

Type	Description
UnityDeleteMediaObject

`}),e.add({id:2042,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/ondeletemediaobject/",title:"OnDeleteMediaObject",section:"ODIN Documentation",description:" Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue ",content:`

public UnityDeleteMediaObject OnDeleteMediaObject

Called if this OdinHandler destroyed a MediaStream that was closed by a remote peer and was requested by the MediaQueue

Info

Invokes after OnMediaRemoved

Value Type

Type	Description
UnityDeleteMediaObject

`}),e.add({id:2043,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onmediaactivestatechanged/",title:"OnMediaActiveStateChanged",section:"ODIN Documentation",description:" Called on every activity change of a media in the same room(s) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaActiveStateChangedProxy OnMediaActiveStateChanged

Called on every activity change of a media in the same room(s)

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2044,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onmediaactivestatechanged/",title:"OnMediaActiveStateChanged",section:"ODIN Documentation",description:" Called on every activity change of a media in the same room(s) ",content:`

public MediaActiveStateChangedProxy OnMediaActiveStateChanged

Called on every activity change of a media in the same room(s)

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2045,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onmediaactivestatechanged/",title:"OnMediaActiveStateChanged",section:"ODIN Documentation",description:" Called on every activity change of a media in the same room(s) ",content:`

public MediaActiveStateChangedProxy OnMediaActiveStateChanged

Called on every activity change of a media in the same room(s)

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2046,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onmediaactivestatechanged/",title:"OnMediaActiveStateChanged",section:"ODIN Documentation",description:" Called on every activity change of a media in the same room(s) ",content:`

public MediaActiveStateChangedProxy OnMediaActiveStateChanged

Called on every activity change of a media in the same room(s)

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2047,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onmediaactivestatechanged/",title:"OnMediaActiveStateChanged",section:"ODIN Documentation",description:" Called on every activity change of a media in the same room(s) ",content:`

public MediaActiveStateChangedProxy OnMediaActiveStateChanged

Called on every activity change of a media in the same room(s)

Value Type

Type	Description
MediaActiveStateChangedProxy

`}),e.add({id:2048,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Called on every Peer that created a media in the same room(s) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaAddedProxy OnMediaAdded

Called on every Peer that created a media in the same room(s)

Value Type

Type	Description
MediaAddedProxy

Discussion

Example

`}),e.add({id:2049,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Called on every Peer that created a media in the same room(s) ",content:`

public MediaAddedProxy OnMediaAdded

Called on every Peer that created a media in the same room(s)

Value Type

Type	Description
MediaAddedProxy

Discussion

Example

`}),e.add({id:2050,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Called on every Peer that created a media in the same room(s) ",content:`

public MediaAddedProxy OnMediaAdded

Called on every Peer that created a media in the same room(s)

Value Type

Type	Description
MediaAddedProxy

Discussion

Example

`}),e.add({id:2051,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Called on every Peer that created a media in the same room(s) ",content:`

public MediaAddedProxy OnMediaAdded

Called on every Peer that created a media in the same room(s)

Value Type

Type	Description
MediaAddedProxy

Discussion

Example

`}),e.add({id:2052,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Additional event redirect from ",content:`

public MediaAddedProxy OnMediaAdded

Additional event redirect from Unity

Info

Usually invoked by MediaAddedPeerCreateComponent(System

Value Type

Type	Description
MediaAddedProxy

`}),e.add({id:2053,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public MediaAddedProxy OnMediaAdded

Event OnMediaStarted redirected as Unity event

Value Type

Type	Description
MediaAddedProxy

`}),e.add({id:2054,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onmediaadded/",title:"OnMediaAdded",section:"ODIN Documentation",description:" Called on every Peer that created a media in the same room(s) ",content:`

public MediaAddedProxy OnMediaAdded

Called on every Peer that created a media in the same room(s)

Value Type

Type	Description
MediaAddedProxy

Discussion

Whenever a “user (in ODIN language it’s a peer) has joined a room and starts sending audio data (i.e. has activated the microphone) this event is triggered.

You need to respond to this event and call the AddPlaybackComponent function of the OdinHandler.Instance like shown in the example below.

Your callback function must have this structure. MediaAddedEventArgs contains information about the peer and the media added to the room:

public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs);

Whenever this callback is triggered, imagine a new player comes in the arena and the game master needs to give him a Walky Talky so that he can listen and talk to the other players.

Example

OnMediaAdded Example

using OdinNative.Odin;
using OdinNative.Odin.Room;
using OdinNative.Unity;
using OdinNative.Unity.Audio;
using UnityEngine;

public class MyOdinPeerManager : MonoBehaviour
{
    private void AttachOdinPlaybackToPlayer(PlayerScript player, Room room, ulong peerId, int mediaId)
    {
        // Create the PlaybackComponent and AudioSource at the players gameObject
        PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(player.gameObject, room.Config.Name, peerId, mediaId);

        // Setup the Playback Component
        playback.CheckPlayingStatusAsInvoke = true; // set checking status as MonoBehaviour.InvokeRepeating active
        playback.PlayingStatusDelay = 1.0f; // (default 0f)
        playback.PlayingStatusRepeatingTime = 0.3f; // (default 0.2f)

        // Make the AudioSource a 3D source (use 0.0 if the volume should be the same regardless of position to the camera)
        playback.PlaybackSource.spatialBlend = 1.0f; // set AudioSource to full 3D
    }

    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        // Called if a peer has started to send audio
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Use the User Data to to map the ODIN peer to the player in the network
        CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
        PlayerScript player = GetPlayerForOdinPeer(userData);
        if (player)
        {
            // We have found a player, attach the ODIN audio to that player
            AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }
}

`}),e.add({id:2055,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Called on every Peer that closed/destroyed one of his own media in the same room(s) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaRemovedProxy OnMediaRemoved

Called on every Peer that closed/destroyed one of his own media in the same room(s)

Info

Invokes before OnDeleteMediaObject

Value Type

Type	Description
MediaRemovedProxy

Discussion

Example

`}),e.add({id:2056,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Called on every Peer that closed/destroyed one of his own media in the same room(s) ",content:`

public MediaRemovedProxy OnMediaRemoved

Called on every Peer that closed/destroyed one of his own media in the same room(s)

Info

Invokes before OnDeleteMediaObject

Value Type

Type	Description
MediaRemovedProxy

Discussion

Example

`}),e.add({id:2057,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Called on every Peer that closed/destroyed one of his own media in the same room(s) ",content:`

public MediaRemovedProxy OnMediaRemoved

Called on every Peer that closed/destroyed one of his own media in the same room(s)

Info

Invokes before OnDeleteMediaObject

Value Type

Type	Description
MediaRemovedProxy

Discussion

Example

`}),e.add({id:2058,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Called on every Peer that closed/destroyed one of his own media in the same room(s) ",content:`

public MediaRemovedProxy OnMediaRemoved

Called on every Peer that closed/destroyed one of his own media in the same room(s)

Info

Invokes before OdinHandler

Value Type

Type	Description
MediaRemovedProxy

Discussion

Example

`}),e.add({id:2059,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Additional event redirect from ",content:`

public MediaRemovedProxy OnMediaRemoved

Additional event redirect from Unity

Info

Usually invoked by MediaRemovedPeerRemoveComponent(System

Value Type

Type	Description
MediaRemovedProxy

`}),e.add({id:2060,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public MediaRemovedProxy OnMediaRemoved

Event OnMediaStopped redirected as Unity event

Value Type

Type	Description
MediaRemovedProxy

`}),e.add({id:2061,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onmediaremoved/",title:"OnMediaRemoved",section:"ODIN Documentation",description:" Called on every Peer that closed/destroyed one of his own media in the same room(s) ",content:`

public MediaRemovedProxy OnMediaRemoved

Called on every Peer that closed/destroyed one of his own media in the same room(s)

Info

Invokes before OnDeleteMediaObject

Value Type

Type	Description
MediaRemovedProxy

Discussion

Whenever a “user (in ODIN language it’s a peer) stops sending audio data (i.e. has deactivated the microphone) this event is triggered.

Your callback function must have this structure. MediaRemovedEventArgs contains information about the peer and the media removed from the room:

public void OnMediaRemoved(object sender, MediaRemovedEventArgs eventArgs);

You need to respond to this event and you need to remove the PlaybackComponent that you have attached to a game object before in the OnMediaAdded callback. You also need to remove the AudioSource from the Game Object which has been created by ODIN automatically.

Example

OnMediaRemoved Example

using OdinNative.Odin;
using OdinNative.Odin.Room;
using OdinNative.Unity;
using OdinNative.Unity.Audio;
using UnityEngine;

public class MyOdinPeerManager : MonoBehaviour
{
    public void RemoveOdinPlaybackFromPlayer(PlayerScript player)
    {
        // Remove the PlaybackComponent and the AudioSource
        PlaybackComponent playback = player.GetComponent<PlaybackComponent>();
        Destroy(playback);

        AudioSource audioSource = player.GetComponent<AudioSource>();
        Destroy(audioSource);
    }

    public void OnMediaRemoved(object sender, MediaRemovedEventArgs eventArgs)
    {
        // Called when the peer stops sending audio
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA REMOVED. Room: {room.Config.Name}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Use the User Data to to map the ODIN peer to the player in the network
        CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
        PlayerScript player = GetPlayerForOdinPeer(userData);
        if (player)
        {
            RemoveOdinPlaybackFromPlayer(player);
        }
    }
}

`}),e.add({id:2062,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onmediastarteddelegate/",title:"OnMediaStartedDelegate",section:"ODIN Documentation",description:" ",content:`

public delegate void OnMediaStartedDelegate(object sender, ulong peerId, MediaRpc media);

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64
media	MediaRpc

`}),e.add({id:2063,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onmediastoppeddelegate/",title:"OnMediaStoppedDelegate",section:"ODIN Documentation",description:" ",content:`

public delegate void OnMediaStoppedDelegate(object sender, ulong peerId, ushort mediaId);

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64
mediaId	UInt16

`}),e.add({id:2064,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Called on every Peer that received message from a peer by ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MessageReceivedProxy OnMessageReceived

Called on every Peer that received message from a peer by

Value Type

Type	Description
MessageReceivedProxy

Example

`}),e.add({id:2065,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Called on every Peer that received message from a peer by ",content:`

public MessageReceivedProxy OnMessageReceived

Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem

Value Type

Type	Description
MessageReceivedProxy

Example

`}),e.add({id:2066,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Called on every Peer that received message from a peer by ",content:`

public MessageReceivedProxy OnMessageReceived

Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem

Value Type

Type	Description
MessageReceivedProxy

Example

`}),e.add({id:2067,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Called on every Peer that received message from a peer by ",content:`

public MessageReceivedProxy OnMessageReceived

Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem

Value Type

Type	Description
MessageReceivedProxy

Example

`}),e.add({id:2068,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public MessageReceivedProxy OnMessageReceived

Event OnMessageReceived redirected as Unity event

Value Type

Type	Description
MessageReceivedProxy

`}),e.add({id:2069,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onmessagereceived/",title:"OnMessageReceived",section:"ODIN Documentation",description:" Called on every Peer that received message from a peer by ",content:`

public MessageReceivedProxy OnMessageReceived

Called on every Peer that received message from a peer by UInt64%5b%5d%2cSystem

Value Type

Type	Description
MessageReceivedProxy

Example

OnMessageReceived Example

class Message
{
	public string text;
	public string type;
}

class MyMessageHandler : MonoBehaviour
{
	public void OnMessageReceived(object sender, MessageReceivedEventArgs args)
	{
		// Get the peer id
		ulong peerId = args.PeerId;

		// Get the data
		byte[] bytes = args.Data;

		// Serialize data in your own classes (just an example, add error handling)
		var bytesAsString = Encoding.UTF8.GetString(bytes);
        var message = JsonConvert.DeserializeObject<Message>(bytesAsString);

        // Show a text chat message
        if (message.type == "chat") {
            UI.ShowIncomingChatMessage(message.text);
        }
	}

	public void SendChatMessage(Room room, string chatMessage)
	{
		var message = new Message{
			type = "chat";
			text = chatMessage;
		}
		var stringMessage = JsonConvert.SerializeObject(message, Formatting.None);
        var bytes = Encoding.UTF8.GetBytes(stringMessage);
		room.SendMessage(bytes);
	}
}

`}),e.add({id:2070,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onmessagereceiveddelegate/",title:"OnMessageReceivedDelegate",section:"ODIN Documentation",description:" ",content:`

public delegate void OnMessageReceivedDelegate(object sender, ulong peerId, byte[] message);

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64
message	Byte[]

`}),e.add({id:2071,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2072,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2073,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2074,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2075,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

public OdinMicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2076,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/onmicrophonedata/",title:"OnMicrophoneData",section:"ODIN Documentation",description:" Event is fired if raw microphone data is available ",content:`

public MicrophoneReader.MicrophoneCallbackDelegate OnMicrophoneData

Event is fired if raw microphone data is available

Value Type

Type	Description
MicrophoneCallbackDelegate

`}),e.add({id:2077,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Called on every Peer that joins the room(s) we're connected to ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PeerJoinedProxy OnPeerJoined

Called on every Peer that joins the room(s) we're connected to

Info

Self is marked as Peer and this handler will trigger this invoke too

Value Type

Type	Description
PeerJoinedProxy

Discussion

Example

`}),e.add({id:2078,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Called on every Peer that joins the room(s) we're connected to ",content:`

public PeerJoinedProxy OnPeerJoined

Called on every Peer that joins the room(s) we're connected to

Info

Self is marked as Peer and this handler will trigger this invoke too

Value Type

Type	Description
PeerJoinedProxy

Discussion

Example

`}),e.add({id:2079,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Called on every Peer that joins the room(s) we're connected to ",content:`

public PeerJoinedProxy OnPeerJoined

Called on every Peer that joins the room(s) we're connected to

Info

Self is marked as Peer and this handler will trigger this invoke too

Value Type

Type	Description
PeerJoinedProxy

Discussion

Example

`}),e.add({id:2080,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Called on every Peer that joins the room(s) we're connected to ",content:`

public PeerJoinedProxy OnPeerJoined

Called on every Peer that joins the room(s) we're connected to

Info

Self is marked as Peer and this handler will trigger this invoke too

Value Type

Type	Description
PeerJoinedProxy

Discussion

Example

`}),e.add({id:2081,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public PeerJoinedProxy OnPeerJoined

Event OnPeerJoined redirected as Unity event

Value Type

Type	Description
PeerJoinedProxy

`}),e.add({id:2082,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onpeerjoined/",title:"OnPeerJoined",section:"ODIN Documentation",description:" Called on every Peer that joins the room(s) we're connected to ",content:`

public PeerJoinedProxy OnPeerJoined

Called on every Peer that joins the room(s) we're connected to

Info

Self is marked as Peer and this handler will trigger this invoke too

Value Type

Type	Description
PeerJoinedProxy

Discussion

Whenever a “user (in ODIN language it’s a peer) joins a room, this event is triggered in all clients. You can listen to this event in your own code as shown in the example above. You can use this to fill an array with active players/users in your game.

The structure of the function looks like this (PeerJoinedProxy ):

public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

In this example, taken from our Integration guide user data is stored in a CustomUserDataJsonFormat format (you can use any format you like). See our guides for more info on this topic.

Example

OnPeerJoined Example

public void OnPeerJoined (object sender, PeerJoinedEventArgs eventArgs)
{
    // Sender is typically a Room instance
    Room room = sender as Room;

    Debug.Log($"ODIN PEER JOINED. Room: {room.Config.Name}, PeerId: {eventInfo.PeerId}, UserData: {eventInfo.Peer.UserData.ToString()}");

    // Use CustomUserDataJsonFormat to parse UserData stored in JSON format
    CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventInfo.Peer.UserData);
    if (userData.seed != null)
    {
        Debug.Log("Player has network Id: " + userData.seed);
        PlayerScript[] players = FindObjectsOfType<PlayerScript>();
        foreach (var player in players)
        {
            if (player.odinSeed == userData.seed)
            {
                Debug.Log("Found PlayerScript with seed " + userData.seed);
                if (player.isLocalPlayer)
                {
                    Debug.Log("Is local player, no need to do anything");
                }
                else
                {
                    // We have matched the OdinPeer with our local player instance
                }
            }
        }
    }
}

`}),e.add({id:2083,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onpeerjoineddelegate/",title:"OnPeerJoinedDelegate",section:"ODIN Documentation",description:" Odin peer joined wrapped data ",content:`

public delegate void OnPeerJoinedDelegate(object sender, ulong peerId, string userId, byte[] userData, MediaRpc[] medias);

Odin peer joined wrapped data

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64
userId	String
userData	Byte[]
medias	MediaRpc[]

`}),e.add({id:2084,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Called on every Peer that left in the same room(s) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PeerLeftProxy OnPeerLeft

Called on every Peer that left in the same room(s)

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2085,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Called on every Peer that left in the same room(s) ",content:`

public PeerLeftProxy OnPeerLeft

Called on every Peer that left in the same room(s)

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2086,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Called on every Peer that left in the same room(s) ",content:`

public PeerLeftProxy OnPeerLeft

Called on every Peer that left in the same room(s)

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2087,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Called on every Peer that left in the same room(s) ",content:`

public PeerLeftProxy OnPeerLeft

Called on every Peer that left in the same room(s)

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2088,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Event redirected as Unity event ",content:`

public PeerLeftProxy OnPeerLeft

Event OnPeerLeft redirected as Unity event

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2089,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onpeerleft/",title:"OnPeerLeft",section:"ODIN Documentation",description:" Called on every Peer that left in the same room(s) ",content:`

public PeerLeftProxy OnPeerLeft

Called on every Peer that left in the same room(s)

Value Type

Type	Description
PeerLeftProxy

`}),e.add({id:2090,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onpeerleftdelegate/",title:"OnPeerLeftDelegate",section:"ODIN Documentation",description:" ",content:`

public delegate void OnPeerLeftDelegate(object sender, ulong peerId);

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64

`}),e.add({id:2091,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onpeeruserdatachanged/",title:"OnPeerUserDataChanged",section:"ODIN Documentation",description:" Called on every Peer that updates his UserData in the same room(s) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public PeerUserDataChangedProxy OnPeerUserDataChanged

Called on every Peer that updates his UserData in the same room(s)

Value Type

Type	Description
PeerUserDataChangedProxy

`}),e.add({id:2092,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onpeeruserdatachanged/",title:"OnPeerUserDataChanged",section:"ODIN Documentation",description:" Called on every Peer that updates his UserData in the same room(s) ",content:`

public PeerUserDataChangedProxy OnPeerUserDataChanged

Called on every Peer that updates his UserData in the same room(s)

Value Type

Type	Description
PeerUserDataChangedProxy

`}),e.add({id:2093,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onpeeruserdatachanged/",title:"OnPeerUserDataChanged",section:"ODIN Documentation",description:" Called on every Peer that updates his UserData in the same room(s) ",content:`

public PeerUserDataChangedProxy OnPeerUserDataChanged

Called on every Peer that updates his UserData in the same room(s)

Value Type

Type	Description
PeerUserDataChangedProxy

`}),e.add({id:2094,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onpeeruserdatachanged/",title:"OnPeerUserDataChanged",section:"ODIN Documentation",description:" Called on every Peer that updates his UserData in the same room(s) ",content:`

public PeerUserDataChangedProxy OnPeerUserDataChanged

Called on every Peer that updates his UserData in the same room(s)

Value Type

Type	Description
PeerUserDataChangedProxy

`}),e.add({id:2095,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onpeeruserdatachanged/",title:"OnPeerUserDataChanged",section:"ODIN Documentation",description:" Called on every Peer that updates his UserData in the same room(s) ",content:`

public PeerUserDataChangedProxy OnPeerUserDataChanged

Called on every Peer that updates his UserData in the same room(s)

Value Type

Type	Description
PeerUserDataChangedProxy

`}),e.add({id:2096,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onroomjoin/",title:"OnRoomJoin",section:"ODIN Documentation",description:" Called before an actual room join ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomJoinProxy OnRoomJoin

Called before an actual room join

Value Type

Type	Description
RoomJoinProxy

`}),e.add({id:2097,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onroomjoin/",title:"OnRoomJoin",section:"ODIN Documentation",description:" Called before an actual room join ",content:`

public RoomJoinProxy OnRoomJoin

Called before an actual room join

Value Type

Type	Description
RoomJoinProxy

`}),e.add({id:2098,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onroomjoin/",title:"OnRoomJoin",section:"ODIN Documentation",description:" Called before an actual room join ",content:`

public RoomJoinProxy OnRoomJoin

Called before an actual room join

Value Type

Type	Description
RoomJoinProxy

`}),e.add({id:2099,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onroomjoin/",title:"OnRoomJoin",section:"ODIN Documentation",description:" Called before an actual room join ",content:`

public RoomJoinProxy OnRoomJoin

Called before an actual room join

Value Type

Type	Description
RoomJoinProxy

`}),e.add({id:2100,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onroomjoin/",title:"OnRoomJoin",section:"ODIN Documentation",description:" Called before an actual room join ",content:`

public RoomJoinProxy OnRoomJoin

Called before an actual room join

Value Type

Type	Description
RoomJoinProxy

`}),e.add({id:2101,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:" Called after a room is joined successfully ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomJoinedProxy OnRoomJoined

Called after a room is joined successfully

Info

Invokes only on success

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2102,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:" Called after a room is joined successfully ",content:`

public RoomJoinedProxy OnRoomJoined

Called after a room is joined successfully

Info

Invokes only on success

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2103,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:" Called after a room is joined successfully ",content:`

public RoomJoinedProxy OnRoomJoined

Called after a room is joined successfully

Info

Invokes only on success

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2104,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:" Called after a room is joined successfully ",content:`

public RoomJoinedProxy OnRoomJoined

Called after a room is joined successfully

Info

Invokes only on success

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2105,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:"",content:`

public RoomJoinedProxy OnRoomJoined

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2106,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onroomjoined/",title:"OnRoomJoined",section:"ODIN Documentation",description:" Called after a room is joined successfully ",content:`

public RoomJoinedProxy OnRoomJoined

Called after a room is joined successfully

Info

Invokes only on success

Value Type

Type	Description
RoomJoinedProxy

`}),e.add({id:2107,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onroomjoineddelegate/",title:"OnRoomJoinedDelegate",section:"ODIN Documentation",description:" Odin room joined bookkeeping ",content:`

public delegate void OnRoomJoinedDelegate(object sender, ulong ownPeerId, string name, byte[] roomUserData, ushort[] mediaIds, ReadOnlyCollection<PeerRpc> peers);

Odin room joined bookkeeping

Parameters

Name	Type	Description
sender	Object	Room object
ownPeerId	UInt64	Self id
name	String	Room name
roomUserData	Byte[]	arbitrary datas
mediaIds	UInt16[]	raw media ids in remote room
peers	ReadOnlyCollection<PeerRpc>	Parsed peer rpc data

`}),e.add({id:2108,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onroomleave/",title:"OnRoomLeave",section:"ODIN Documentation",description:" Called before a room leave ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomLeaveProxy OnRoomLeave

Called before a room leave

Value Type

Type	Description
RoomLeaveProxy

`}),e.add({id:2109,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onroomleave/",title:"OnRoomLeave",section:"ODIN Documentation",description:" Called before a room leave ",content:`

public RoomLeaveProxy OnRoomLeave

Called before a room leave

Value Type

Type	Description
RoomLeaveProxy

`}),e.add({id:2110,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onroomleave/",title:"OnRoomLeave",section:"ODIN Documentation",description:" Called before a room leave ",content:`

public RoomLeaveProxy OnRoomLeave

Called before a room leave

Value Type

Type	Description
RoomLeaveProxy

`}),e.add({id:2111,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onroomleave/",title:"OnRoomLeave",section:"ODIN Documentation",description:" Called before a room leave ",content:`

public RoomLeaveProxy OnRoomLeave

Called before a room leave

Value Type

Type	Description
RoomLeaveProxy

`}),e.add({id:2112,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onroomleave/",title:"OnRoomLeave",section:"ODIN Documentation",description:" Called before a room leave ",content:`

public RoomLeaveProxy OnRoomLeave

Called before a room leave

Value Type

Type	Description
RoomLeaveProxy

`}),e.add({id:2113,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onroomleft/",title:"OnRoomLeft",section:"ODIN Documentation",description:" Called after a room is destroyed ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomLeftProxy OnRoomLeft

Called after a room is destroyed

Value Type

Type	Description
RoomLeftProxy

Discussion

Example

`}),e.add({id:2114,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onroomleft/",title:"OnRoomLeft",section:"ODIN Documentation",description:" Called after a room is destroyed ",content:`

public RoomLeftProxy OnRoomLeft

Called after a room is destroyed

Value Type

Type	Description
RoomLeftProxy

Discussion

Example

`}),e.add({id:2115,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onroomleft/",title:"OnRoomLeft",section:"ODIN Documentation",description:" Called after a room is destroyed ",content:`

public RoomLeftProxy OnRoomLeft

Called after a room is destroyed

Value Type

Type	Description
RoomLeftProxy

Discussion

Example

`}),e.add({id:2116,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onroomleft/",title:"OnRoomLeft",section:"ODIN Documentation",description:" Called after a room is destroyed ",content:`

public RoomLeftProxy OnRoomLeft

Called after a room is destroyed

Value Type

Type	Description
RoomLeftProxy

Discussion

Example

`}),e.add({id:2117,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onroomleft/",title:"OnRoomLeft",section:"ODIN Documentation",description:" Called after a room is destroyed ",content:`

public RoomLeftProxy OnRoomLeft

Called after a room is destroyed

Value Type

Type	Description
RoomLeftProxy

Discussion

Whenever a “user (in ODIN language it’s a peer) leaves a room, this event is triggered on the local client. You need to listen to this event and doing some cleanup work as some PlaybackComponent elements created in the OnMediaAdded event might be linked to this room and will stop working once the user left the room.

You can use the DestroyPlaybackComponents convenience function to remove all PlaybackComponent linked to this room.

Example

OnRoomLeft Example

public void OnRoomLeft(RoomLeftEventArgs eventArgs)
{
    // Remove all Playback Components linked to this room
    OdinHandler.Instance.DestroyPlaybackComponents(eventArgs.RoomName);
}

`}),e.add({id:2118,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/onroomuserdatachanged/",title:"OnRoomUserDataChanged",section:"ODIN Documentation",description:" Called on the Room that updates his UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomUserDataChangedProxy OnRoomUserDataChanged

Called on the Room that updates his UserData

Value Type

Type	Description
RoomUserDataChangedProxy

`}),e.add({id:2119,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/onroomuserdatachanged/",title:"OnRoomUserDataChanged",section:"ODIN Documentation",description:" Called on the Room that updates his UserData ",content:`

public RoomUserDataChangedProxy OnRoomUserDataChanged

Called on the Room that updates his UserData

Value Type

Type	Description
RoomUserDataChangedProxy

`}),e.add({id:2120,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/onroomuserdatachanged/",title:"OnRoomUserDataChanged",section:"ODIN Documentation",description:" Called on the Room that updates his UserData ",content:`

public RoomUserDataChangedProxy OnRoomUserDataChanged

Called on the Room that updates his UserData

Value Type

Type	Description
RoomUserDataChangedProxy

`}),e.add({id:2121,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/onroomuserdatachanged/",title:"OnRoomUserDataChanged",section:"ODIN Documentation",description:" Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK. ",content:`

public RoomUserDataChangedProxy OnRoomUserDataChanged

Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.

Value Type

Type	Description
RoomUserDataChangedProxy

`}),e.add({id:2122,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/onroomuserdatachanged/",title:"OnRoomUserDataChanged",section:"ODIN Documentation",description:" Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK. ",content:`

public RoomUserDataChangedProxy OnRoomUserDataChanged

Called on the Room that updates his UserData. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.

Value Type

Type	Description
RoomUserDataChangedProxy

`}),e.add({id:2123,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/onrpc/",title:"OnRpc",section:"ODIN Documentation",description:" Redirect of ",content:`

public RpcProxy OnRpc

Redirect of OnRpc

Value Type

Type	Description
RpcProxy

`}),e.add({id:2124,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/onuserdatachangeddelegate/",title:"OnUserDataChangedDelegate",section:"ODIN Documentation",description:" ",content:`

public delegate void OnUserDataChangedDelegate(object sender, ulong peerId, byte[] userData);

Parameters

Name	Type	Description
sender	Object	Room object
peerId	UInt64
userData	Byte[]

`}),e.add({id:2125,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/outchannels/",title:"OutChannels",section:"ODIN Documentation",description:" Gets the current speaker mode. Default is 2 channel stereo. ",content:`

public int OutChannels { get; }

Gets the current speaker mode. Default is 2 channel stereo.

Value Type

Type	Description
Int32

`}),e.add({id:2126,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/outsamplerate/",title:"OutSampleRate",section:"ODIN Documentation",description:"",content:`

public int OutSampleRate { get; }

Value Type

Type	Description
Int32

`}),e.add({id:2127,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool OverrideSampleRate

Use set DeviceSampleRate on false

Value Type

Type	Description
Boolean

`}),e.add({id:2128,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool OverrideSampleRate

Use set RemoteSampleRate on false

Value Type

Type	Description
Boolean

`}),e.add({id:2129,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

public bool OverrideSampleRate

Use set DeviceSampleRate on false

Value Type

Type	Description
Boolean

`}),e.add({id:2130,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

public bool OverrideSampleRate

Use set DeviceSampleRate on false

Value Type

Type	Description
Boolean

`}),e.add({id:2131,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

public bool OverrideSampleRate

Use set OdinEditorConfig on false

Value Type

Type	Description
Boolean

`}),e.add({id:2132,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/overridesamplerate/",title:"OverrideSampleRate",section:"ODIN Documentation",description:" Use set on true, on false ",content:`

public bool OverrideSampleRate

Use set DeviceSampleRate on false

Value Type

Type	Description
Boolean

`}),e.add({id:2133,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/ownpeer/",title:"ownPeer",section:"ODIN Documentation",description:"An instance of your own `OdinPeer` in the room.",content:`

OdinPeer

An instance of your own OdinPeer in the room.

Value Type

Type	Description
UInt64

`}),e.add({id:2137,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/ownuserid/",title:"ownUserId",section:"ODIN Documentation",description:"The ID of the local user. It is the same as the user id that was passed to join.",content:`

public ownUserId: string

The ID of the local user. It is the same as the user id that was passed to join.

`}),e.add({id:2138,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/packetsavailabledifference/",title:"PacketsAvailableDifference",section:"ODIN Documentation",description:"",content:`

public AnimationCurve PacketsAvailableDifference

Value Type

Type	Description
AnimationCurve

`}),e.add({id:2139,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/packetsavailabledifference/",title:"PacketsAvailableDifference",section:"ODIN Documentation",description:"",content:`

public AnimationCurve PacketsAvailableDifference

Value Type

Type	Description
AnimationCurve

`}),e.add({id:2140,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/packetsavailabledifference/",title:"PacketsAvailableDifference",section:"ODIN Documentation",description:"",content:`

public AnimationCurve PacketsAvailableDifference

Value Type

Type	Description
AnimationCurve

`}),e.add({id:2141,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/packetsavailabledifference/",title:"PacketsAvailableDifference",section:"ODIN Documentation",description:"",content:`

public AnimationCurve PacketsAvailableDifference

Value Type

Type	Description
AnimationCurve

`}),e.add({id:2142,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/packetsdroppedearly/",title:"PacketsDroppedEarly",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedEarly

Value Type

Type	Description
UInt32

`}),e.add({id:2143,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/packetsdroppedearly/",title:"PacketsDroppedEarly",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedEarly

Value Type

Type	Description
UInt32

`}),e.add({id:2144,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/packetsdroppedearly/",title:"PacketsDroppedEarly",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedEarly

Value Type

Type	Description
UInt32

`}),e.add({id:2145,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/packetsdroppedearly/",title:"PacketsDroppedEarly",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedEarly

Value Type

Type	Description
UInt32

`}),e.add({id:2146,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/packetsdroppedlate/",title:"PacketsDroppedLate",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedLate

Value Type

Type	Description
UInt32

`}),e.add({id:2147,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/packetsdroppedlate/",title:"PacketsDroppedLate",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedLate

Value Type

Type	Description
UInt32

`}),e.add({id:2148,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/packetsdroppedlate/",title:"PacketsDroppedLate",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedLate

Value Type

Type	Description
UInt32

`}),e.add({id:2149,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/packetsdroppedlate/",title:"PacketsDroppedLate",section:"ODIN Documentation",description:"",content:`

public uint PacketsDroppedLate

Value Type

Type	Description
UInt32

`}),e.add({id:2150,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/packetslost/",title:"PacketsLost",section:"ODIN Documentation",description:"",content:`

public uint PacketsLost

Value Type

Type	Description
UInt32

`}),e.add({id:2151,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/packetslost/",title:"PacketsLost",section:"ODIN Documentation",description:"",content:`

public uint PacketsLost

Value Type

Type	Description
UInt32

`}),e.add({id:2152,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/packetslost/",title:"PacketsLost",section:"ODIN Documentation",description:"",content:`

public uint PacketsLost

Value Type

Type	Description
UInt32

`}),e.add({id:2153,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/packetslost/",title:"PacketsLost",section:"ODIN Documentation",description:"",content:`

public uint PacketsLost

Value Type

Type	Description
UInt32

`}),e.add({id:2154,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/packetsprocessed/",title:"PacketsProcessed",section:"ODIN Documentation",description:"",content:`

public uint PacketsProcessed

Value Type

Type	Description
UInt32

`}),e.add({id:2155,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/packetsprocessed/",title:"PacketsProcessed",section:"ODIN Documentation",description:"",content:`

public uint PacketsProcessed

Value Type

Type	Description
UInt32

`}),e.add({id:2156,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/packetsprocessed/",title:"PacketsProcessed",section:"ODIN Documentation",description:"",content:`

public uint PacketsProcessed

Value Type

Type	Description
UInt32

`}),e.add({id:2157,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/packetsprocessed/",title:"PacketsProcessed",section:"ODIN Documentation",description:"",content:`

public uint PacketsProcessed

Value Type

Type	Description
UInt32

`}),e.add({id:2158,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/notification/paramsindex/",title:"ParamsIndex",section:"ODIN Documentation",description:" params field (params) ",content:`

public const int ParamsIndex = 2

params field (params)

Value Type

Type	Description
Int32

`}),e.add({id:2159,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/request/paramsindex/",title:"ParamsIndex",section:"ODIN Documentation",description:" binary field (params) ",content:`

public const int ParamsIndex = 3

binary field (params)

Value Type

Type	Description
Int32

`}),e.add({id:2160,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/parent/",title:"Parent",section:"ODIN Documentation",description:" Default value null indicates root or not set ",content:`

public IPeer Parent { get; set; }

Default value

null

indicates root or not set

Value Type

Type	Description
IPeer

`}),e.add({id:2161,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/parent/",title:"Parent",section:"ODIN Documentation",description:" Default value null indicates root or not set ",content:`

public IPeer Parent { get; set; }

Default value

null

indicates root or not set

Value Type

Type	Description
IPeer

`}),e.add({id:2162,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/parent/",title:"Parent",section:"ODIN Documentation",description:"",content:`

public IPeer Parent { get; set; }

Value Type

Type	Description
IPeer

`}),e.add({id:2163,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/parent/",title:"Parent",section:"ODIN Documentation",description:"",content:`

public IRoom Parent { get; set; }

Value Type

Type	Description
IRoom

`}),e.add({id:2164,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/parent/",title:"Parent",section:"ODIN Documentation",description:" Default value gameObject parent or Unity root ",content:`

public object Parent { get; }

Default value gameObject parent or Unity root

Value Type

Type	Description
Object

`}),e.add({id:2165,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/parent/",title:"Parent",section:"ODIN Documentation",description:" Default value null indicates root or not set ",content:`

public IRoom Parent { get; set; }

Default value

null

indicates root or not set

Value Type

Type	Description
IRoom

`}),e.add({id:2166,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/parent/",title:"Parent",section:"ODIN Documentation",description:" Pipeline handle ",content:`

public OdinPipelineHandle Parent { get; }

Pipeline handle

Value Type

Type	Description
OdinPipelineHandle

`}),e.add({id:2167,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/parent/",title:"Parent",section:"ODIN Documentation",description:" Default value null indicates root or not set ",content:`

public object Parent { get; set; }

Default value

null

indicates root or not set

Value Type

Type	Description
Object

`}),e.add({id:2168,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2169,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2170,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2171,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2172,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2173,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/patternat/",title:"PatternAt",section:"ODIN Documentation",description:"",content:`

public virtual IEnumerable<int> PatternAt(byte[] pattern)

Indicates whether two sequence are equal

Parameters

Name	Type	Description
pattern	Byte[]	byte sequence

Returns

Type	Description
IEnumerable<Int32>	true if contain

`}),e.add({id:2174,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/pause/",title:"pause",section:"ODIN Documentation",description:"Instructs the server to pause the media object, ceasing the reception of data. This operation essentially communicates a server-side mute request from the client, thus indicating a desire to halt packet reception for this media stream.",content:`

public pause(): void

Instructs the server to pause the media object, ceasing the reception of data. This operation essentially communicates a server-side mute request from the client, thus indicating a desire to halt packet reception for this media stream.

Returns

Type	Description
void

`}),e.add({id:2175,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/pause/",title:"pause",section:"ODIN Documentation",description:"Paused the media stream on the server to stop receiving data on it.",content:`

pause(): Promise<void>

Paused the media stream on the server to stop receiving data on it.

Returns

Type	Description
Promise<void>

`}),e.add({id:2176,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/pauseanimationcurve/",title:"PauseAnimationCurve",section:"ODIN Documentation",description:"",content:`

public bool PauseAnimationCurve

Value Type

Type	Description
Boolean

`}),e.add({id:2177,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/pauseanimationcurve/",title:"PauseAnimationCurve",section:"ODIN Documentation",description:"",content:`

public bool PauseAnimationCurve

Value Type

Type	Description
Boolean

`}),e.add({id:2178,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/pauseanimationcurve/",title:"PauseAnimationCurve",section:"ODIN Documentation",description:"",content:`

public bool PauseAnimationCurve

Value Type

Type	Description
Boolean

`}),e.add({id:2179,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/pauseanimationcurve/",title:"PauseAnimationCurve",section:"ODIN Documentation",description:"",content:`

public bool PauseAnimationCurve

Value Type

Type	Description
Boolean

`}),e.add({id:2180,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/paused/",title:"paused",section:"ODIN Documentation",description:"Indicates wether or not the media is paused.",content:`

boolean

Indicates wether or not the media is paused.

`}),e.add({id:2181,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/mediarpc/paused/",title:"Paused",section:"ODIN Documentation",description:" media state ",content:`

public bool Paused

media state

Value Type

Type	Description
Boolean

`}),e.add({id:2182,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/pausemedia/",title:"PauseMedia",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> PauseMedia(MediaDecoder decoder)
public virtual Task<RpcResult> PauseMedia(ushort mediaId)

Send a "PauseMedia" to the server to stop the decoder for output.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
decoder	MediaDecoder	output media to stop
mediaId	UInt16	raw id to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

PauseMedia(decoder)

public virtual Task<RpcResult> PauseMedia(MediaDecoder decoder)

Send a "PauseMedia" to the server to stop the decoder for output.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
decoder	MediaDecoder	output media to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

PauseMedia(mediaId)

public virtual Task<RpcResult> PauseMedia(ushort mediaId)

Send a "PauseMedia" to the server to stop the decoder for output.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
mediaId	UInt16	raw id to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2183,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/pauseoutputmedia/",title:"PauseOutputMedia",section:"ODIN Documentation",description:"",content:`

public virtual bool PauseOutputMedia(OdinMedia media)
public virtual bool PauseOutputMedia(MediaDecoder decoder)

Stop a started remote output decoder

Parameters

Name	Type	Description
media	OdinMedia	output wrapper
decoder	MediaDecoder	output

Returns

Type	Description
Boolean	true on stop or false

Variants

PauseOutputMedia(media)

public virtual bool PauseOutputMedia(OdinMedia media)

Stop a started remote output decoder

Parameters

Name	Type	Description
media	OdinMedia	output wrapper

Returns

Type	Description
Boolean	true on stop or false

PauseOutputMedia(decoder)

public virtual bool PauseOutputMedia(MediaDecoder decoder)

Stop a started remote output decoder

Parameters

Name	Type	Description
decoder	MediaDecoder	output

Returns

Type	Description
Boolean	true on stop or false

`}),e.add({id:2184,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/payload/",title:"payload",section:"ODIN Documentation",description:" byte[] ",content:`

public IntPtr payload

byte[]

Value Type

Type	Description
IntPtr

`}),e.add({id:2185,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/payload/",title:"payload",section:"ODIN Documentation",description:" byte[] ",content:`

public IntPtr payload

byte[]

Value Type

Type	Description
IntPtr

`}),e.add({id:2186,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinevent/payload/",title:"payload",section:"ODIN Documentation",description:"Custom payload of the event (see `IOdin*Payload` interfaces).",content:`

Custom payload of the event (see IOdin*Payload interfaces).

`}),e.add({id:2187,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagrameventargs/payload/",title:"Payload",section:"ODIN Documentation",description:" decoder datagram payload ",content:`

public byte[] Payload { get; }

decoder datagram payload

Value Type

Type	Description
Byte[]

`}),e.add({id:2188,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/payload_length/",title:"payload_length",section:"ODIN Documentation",description:"",content:`

public UInt32 payload_length

Value Type

Type	Description
UInt32

`}),e.add({id:2189,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/payload_length/",title:"payload_length",section:"ODIN Documentation",description:"",content:`

public UInt32 payload_length

Value Type

Type	Description
UInt32

`}),e.add({id:2190,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmediaactivitychangedeventpayload/peer/",title:"peer",section:"ODIN Documentation",description:"The peer that owns the media.",content:`

OdinPeer

The peer that owns the media.

Value Type

Type	Description
Peer

`}),e.add({id:2195,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaremovedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2196,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/",title:"Peer",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class Peer : IDisposable

Client/Remote peer

Properties

Name	Type	Description
Id	UInt64	Peer id
RoomName	String	Associated room name of this peer
UserId	String	Peers user id
UserData	UserData	Peer userdata
Medias	MediaCollection	Associated medias of this peer

Public Methods

Name	Description
AddMedia	Associate a media with the peer
RemoveMedia	Remove a associated media from the peer
GetMediaStreamIds	Get a copy of all ids of Media from this peer
SetMuteMedias	Set IsMuted on each current associated Media
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2197,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerjoinedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2198,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2199,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaaddedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2200,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaremovedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2201,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/",title:"Peer",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public class Peer : IDisposable

Client/Remote peer

Properties

Name	Type	Description
Id	UInt64	Peer id
RoomName	String	Associated room name of this peer
UserId	String	Peers user id
UserData	UserData	Peer userdata
Medias	MediaCollection	Associated medias of this peer

Public Methods

Name	Description
AddMedia	Associate a media with the peer
RemoveMedia	Remove a associated media from the peer
GetMediaStreamIds	Get a copy of all ids of Media from this peer
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2202,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerjoinedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2203,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2204,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaaddedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2205,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaremovedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2206,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/",title:"Peer",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public class Peer : IDisposable

Client/Remote peer

Properties

Name	Type	Description
Id	UInt64	Peer id
RoomName	String	Associated room name of this peer
UserId	String	Peers user id
UserData	UserData	Peer userdata
Medias	MediaCollection	Associated medias of this peer

Public Methods

Name	Description
AddMedia	Associate a media with the peer
RemoveMedia	Remove a associated media from the peer
GetMediaStreamIds	Get a copy of all ids of Media from this peer
SetMuteMedias	Set IsMuted on each current associated Media
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2207,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerjoinedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2208,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2209,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaaddedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2210,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaremovedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2211,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/",title:"Peer",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public class Peer : IDisposable

Client/Remote peer

Constructors

Name	Description
Peer(UInt64, String, UserData)	Client/Remote peer

Properties

Name	Description
Id	Peer id
RoomName	Associated room name of this peer
UserId	Peers user id
UserData	Peer userdata
Medias	Associated medias of this peer

Public Methods

Name	Description
AddMedia	Associate a media with the peer
RemoveMedia	Remove a associated media from the peer
GetMediaStreamIds	Get a copy of all ids of Media from this peer
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2212,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerjoinedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2213,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2214,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public PeerEntity Peer

peer object

Value Type

Type	Description
PeerEntity

`}),e.add({id:2215,href:"https://www.4players.io/odin/sdk/unity/classes/mediaaddedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2216,href:"https://www.4players.io/odin/sdk/unity/classes/mediaremovedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2217,href:"https://www.4players.io/odin/sdk/unity/classes/peer/",title:"Peer",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public class Peer : IDisposable

Client/Remote peer

Constructors

Name	Description
Peer(UInt64, String, UserData)	Client/Remote peer

Properties

Name	Description
Id	Peer id
RoomName	Associated room name of this peer
UserId	Peers user id
UserData	Peer userdata
Medias	Associated medias of this peer

Public Methods

Name	Description
AddMedia	Associate a media with the peer
RemoveMedia	Remove a associated media from the peer
GetMediaStreamIds	Get a copy of all ids of Media from this peer
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2218,href:"https://www.4players.io/odin/sdk/unity/classes/peerjoinedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2219,href:"https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedeventargs/peer/",title:"Peer",section:"ODIN Documentation",description:" peer object ",content:`

public Peer Peer

peer object

Value Type

Type	Description
Peer

`}),e.add({id:2220,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/peer_mediaadded/",title:"Peer_MediaAdded",section:"ODIN Documentation",description:"",content:`

public virtual void Peer_MediaAdded(object sender, MediaAddedEventArgs args)

Event trigger to create a Unity component

Parameters

Name	Type	Description
sender	Object	OdinRoom object
args	MediaAddedEventArgs	started media data

`}),e.add({id:2221,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/peer_mediaremoved/",title:"Peer_MediaRemoved",section:"ODIN Documentation",description:"",content:`

public virtual void Peer_MediaRemoved(object sender, MediaRemovedEventArgs args)

Event trigger to remove a Unity component

Parameters

Name	Type	Description
sender	Object	OdinRoom object
args	MediaRemovedEventArgs	stopped media data

`}),e.add({id:2222,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/constructor_0/",title:"Peer(UInt64, String, UserData)",section:"ODIN Documentation",description:"",content:`

public Peer(ulong id, string roomName, UserData userData)

Client/Remote peer

Parameters

Name	Description
id	peer id
roomName	name of the room
userData	initial userdata

`}),e.add({id:2223,href:"https://www.4players.io/odin/sdk/unity/classes/peer/constructor_0/",title:"Peer(UInt64, String, UserData)",section:"ODIN Documentation",description:"",content:`

public Peer(ulong id, string roomName, UserData userData)

Client/Remote peer

Parameters

Name	Description
id	peer id
roomName	name of the room
userData	initial userdata

`}),e.add({id:2224,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/",title:"PeerCollection",section:"ODIN Documentation",description:" Intern peer dictionary ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerCollection : IReadOnlyCollection<Peer>, IEqualityComparer<Peer>

Intern peer dictionary

Properties

Name	Type	Description
Item[UInt64]	Peer	Try to get Peer by id
Count	Int32	Count of peers in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a peer to the collection
Clear	Free and empty the collection
Contains	Determines whether the peer by id is in the collection
CopyTo	Copies peers of the collection to an array
Equals	Determines whether the peers are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a peer by id from the collection

`}),e.add({id:2225,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/",title:"PeerCollection",section:"ODIN Documentation",description:" Intern peer dictionary ",content:`

public class PeerCollection : IReadOnlyCollection<Peer>, IEnumerable<Peer>, IEnumerable, IEqualityComparer<Peer>

Intern peer dictionary

Properties

Name	Type	Description
Item[UInt64]	Peer	Try to get Peer by id
Count	Int32	Count of peers in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a peer to the collection
Clear	Free and empty the collection
Contains	Determines whether the peer by id is in the collection
CopyTo	Copies peers of the collection to an array
Equals	Determines whether the peers are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a peer by id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2226,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/",title:"PeerCollection",section:"ODIN Documentation",description:" Intern peer dictionary ",content:`

public class PeerCollection : IReadOnlyCollection<Peer>, IEqualityComparer<Peer>

Intern peer dictionary

Properties

Name	Type	Description
Item[UInt64]	Peer	Try to get Peer by id
Count	Int32	Count of peers in the collection
IsReadOnly	Boolean	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a peer to the collection
Clear	Free and empty the collection
Contains	Determines whether the peer by id is in the collection
CopyTo	Copies peers of the collection to an array
Equals	Determines whether the peers are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a peer by id from the collection

`}),e.add({id:2227,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/",title:"PeerCollection",section:"ODIN Documentation",description:" Intern peer dictionary ",content:`

public class PeerCollection : IReadOnlyCollection<Peer>, IEnumerable<Peer>, IEnumerable, IEqualityComparer<Peer>

Intern peer dictionary

Constructors

Name	Description
PeerCollection()	Intern peer dictionary

Properties

Name	Description
Item[UInt64]	Try to get Peer by id
Count	Count of peers in the collection
IsReadOnly	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a peer to the collection
Clear	Free and empty the collection
Contains	Determines whether the peer by id is in the collection
CopyTo	Copies peers of the collection to an array
Equals	Determines whether the peers are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a peer by id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2228,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/",title:"PeerCollection",section:"ODIN Documentation",description:" Intern peer dictionary ",content:`

public class PeerCollection : IReadOnlyCollection<Peer>, IEnumerable<Peer>, IEnumerable, IEqualityComparer<Peer>

Intern peer dictionary

Constructors

Name	Description
PeerCollection()	Intern peer dictionary

Properties

Name	Description
Item[UInt64]	Try to get Peer by id
Count	Count of peers in the collection
IsReadOnly	Indicates whether elements can be added or removed from the collection

Public Methods

Name	Description
Add	Add a peer to the collection
Clear	Free and empty the collection
Contains	Determines whether the peer by id is in the collection
CopyTo	Copies peers of the collection to an array
Equals	Determines whether the peers are equal
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Remove a peer by id from the collection
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2229,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/constructor_0/",title:"PeerCollection()",section:"ODIN Documentation",description:"",content:`

public PeerCollection()

Intern peer dictionary

`}),e.add({id:2230,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/constructor_0/",title:"PeerCollection()",section:"ODIN Documentation",description:"",content:`

public PeerCollection()

Intern peer dictionary

`}),e.add({id:2231,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/",title:"PeerEntity",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public class PeerEntity : IPeer, IDisposable

Client/Remote peer

Constructors

Name	Description
PeerEntity(UInt64)	Client/Remote peer

Properties

Name	Description
Id	Peer id
UserId	Peers user id
UserData	Peer userdata
Medias	Peer output medias
Parent	Default value null indicates root or not set

Public Methods

Name	Description
GetBasePeer
GetRoomApi
GetDecoder	Get a output media by id.
GetOrCreateDecoder	Get a output media by id. If the decoder is not found create a new one that will be added PeerEntity
CreateDecoder	Create a new output media that will be added to PeerEntity
RemoveDecoder	Remove the output media from PeerEntity
ToString	Debug
Dispose	Free peer with all associated medias

`}),e.add({id:2232,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/constructor_0/",title:"PeerEntity(UInt64)",section:"ODIN Documentation",description:"",content:`

public PeerEntity(ulong id)

Client/Remote peer

Parameters

Name	Description
id	peer id

`}),e.add({id:2233,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinaudiodatareceivedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that sent the audio data.",content:`

public peerId: number

The ID of the peer that sent the audio data.

`}),e.add({id:2234,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaactivityeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that changed the media activity.",content:`

public peerId: number

The ID of the peer that changed the media activity.

`}),e.add({id:2235,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaaddedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that added the media.",content:`

public peerId: number

The ID of the peer that added the media.

`}),e.add({id:2236,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaremovedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that removed the media.",content:`

public peerId: number

The ID of the peer that removed the media.

`}),e.add({id:2237,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmessagereceivedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that sent the message.",content:`

public peerId: number

The ID of the peer that sent the message.

`}),e.add({id:2238,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that joined.",content:`

public peerId: number

The ID of the peer that joined.

`}),e.add({id:2239,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerlefteventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that left.",content:`

public peerId: number

The ID of the peer that left.

`}),e.add({id:2240,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeeruserdatachangedeventpayload/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that changed the user data.",content:`

public peerId: number

The ID of the peer that changed the user data.

`}),e.add({id:2241,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/peerid/",title:"peerId",section:"ODIN Documentation",description:"The ID of the peer that owns the media.",content:`

number

The ID of the peer that owns the media.

`}),e.add({id:2242,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2243,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2244,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2245,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer Id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer Id

Value Type

Type	Description
UInt64

`}),e.add({id:2246,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2247,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2248,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/peerid/",title:"PeerId",section:"ODIN Documentation",description:" Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong PeerId { get; set; }

Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.

Info

Invalid values will cause errors.

Value Type

Type	Description
UInt64

`}),e.add({id:2249,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2250,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2251,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2252,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer Id ",content:`

public ulong PeerId { get; }

peer Id

Value Type

Type	Description
UInt64

`}),e.add({id:2253,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2254,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2255,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/peerid/",title:"PeerId",section:"ODIN Documentation",description:" Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room. ",content:`

public ulong PeerId { get; set; }

Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.

Info

Invalid values will cause errors.

Value Type

Type	Description
UInt64

`}),e.add({id:2256,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2257,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2258,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2259,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer Id ",content:`

public ulong PeerId { get; }

peer Id

Value Type

Type	Description
UInt64

`}),e.add({id:2260,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2261,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2262,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/peerid/",title:"PeerId",section:"ODIN Documentation",description:" Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room. ",content:`

public ulong PeerId { get; set; }

Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.

Info

Invalid values will cause errors.

Value Type

Type	Description
UInt64

`}),e.add({id:2263,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2264,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2265,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2266,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer Id ",content:`

public ulong PeerId { get; }

peer Id

Value Type

Type	Description
UInt64

`}),e.add({id:2267,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2268,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2269,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/peerid/",title:"PeerId",section:"ODIN Documentation",description:" Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room. ",content:`

public ulong PeerId { get; set; }

Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.

Info

Invalid values will cause errors.

Value Type

Type	Description
UInt64

`}),e.add({id:2270,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2271,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2272,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaremovedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer object ",content:`

public ulong PeerId { get; }

peer object

Value Type

Type	Description
UInt64

`}),e.add({id:2273,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2274,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:"",content:`

public ulong PeerId

Value Type

Type	Description
UInt64

`}),e.add({id:2275,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2276,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2277,href:"https://www.4players.io/odin/sdk/unity/classes/mediaactivestatechangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2278,href:"https://www.4players.io/odin/sdk/unity/classes/mediaaddedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2279,href:"https://www.4players.io/odin/sdk/unity/classes/messagereceivedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2280,href:"https://www.4players.io/odin/sdk/unity/classes/peerjoinedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer Id ",content:`

public ulong PeerId { get; }

peer Id

Value Type

Type	Description
UInt64

`}),e.add({id:2281,href:"https://www.4players.io/odin/sdk/unity/classes/peerlefteventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2282,href:"https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedeventargs/peerid/",title:"PeerId",section:"ODIN Documentation",description:" peer id ",content:`

public ulong PeerId { get; }

peer id

Value Type

Type	Description
UInt64

`}),e.add({id:2283,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/peerid/",title:"PeerId",section:"ODIN Documentation",description:" Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room. ",content:`

public ulong PeerId { get; set; }

Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.

Info

Invalid values will cause errors.

Value Type

Type	Description
UInt64

`}),e.add({id:2284,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/peerjoined/",title:"PeerJoined",section:"ODIN Documentation",description:"Fired when a remote peer joined the room. This event is fired for all existing peers in the room before the Joined event is fired.",content:`

public PeerJoined: OdinPeerJoinedEvent

Fired when a remote peer joined the room. This event is fired for all existing peers in the room before the Joined event is fired.

Parameters

Name	Type	Description
sender	Object	OdinRoom object
args	PeerJoinedEventArgs	peer join data

`}),e.add({id:2287,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool PeerJoinedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2288,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool PeerJoinedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2289,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerJoinedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2290,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerJoinedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2291,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerJoinedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2292,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerJoinedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2293,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerJoinedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2294,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerJoinedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2295,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerJoinedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2296,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/peerjoinedevent/",title:"PeerJoinedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerJoinedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2297,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer Id
UserId	String	user Id
Peer	Peer	peer object

`}),e.add({id:2298,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

Inherits from:

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer Id
UserId	String	user Id
Peer	Peer	peer object

`}),e.add({id:2299,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer Id
UserId	String	user Id
Peer	Peer	peer object

`}),e.add({id:2300,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

Inherits from:

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Description
PeerId	peer Id
UserId	user Id
Peer	peer object

`}),e.add({id:2301,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Description
PeerId
UserId
UserData
MediaIds

`}),e.add({id:2302,href:"https://www.4players.io/odin/sdk/unity/classes/peerjoinedeventargs/",title:"PeerJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerJoined events in the current room ",content:`

Inherits from:

public class PeerJoinedEventArgs : EventArgs

Arguments for PeerJoined events in the current room

Properties

Name	Description
PeerId	peer Id
UserId	user Id
Peer	peer object

`}),e.add({id:2303,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:2304,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:2305,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Example

`}),e.add({id:2306,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2307,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2308,href:"https://www.4players.io/odin/sdk/unity/classes/peerjoinedproxy/",title:"PeerJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerJoinedProxy : UnityEvent<object, PeerJoinedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

Discussion

Defines the structure of the OnPeerJoined event. See PeerJoinedEventArgs for more info on the payload sent with this event.

sender is typically an instance of the Room class.

You need to create a function with this prototype and then link the OnPeerJoined that you can find in the inspector of the Odin Handler Prefab or use code to attach a listener to that event of your OdinHandler instance like so:

OdinHandler.Instance.OnPeerJoined.AddListener(OnPeerJoined);

Example

PeerJoinedProxy Example

public void OnPeerJoined (object sender, PeerJoinedEventArgs eventArgs)
{
    // Sender is typically a Room instance
    Room room = sender as Room;
}

`}),e.add({id:2309,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/peerleft/",title:"PeerLeft",section:"ODIN Documentation",description:"Fired when a remote peer left the room.",content:`

public PeerLeft: OdinPeerLeftEvent

Fired when a remote peer left the room.

Value Type

Type	Description
Boolean

`}),e.add({id:2312,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool PeerLeftEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2313,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerLeftEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2314,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerLeftEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2315,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerLeftEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2316,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerLeftEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2317,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerLeftEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2318,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerLeftEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2319,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerLeftEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2320,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/peerleftevent/",title:"PeerLeftEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerLeftEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2321,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id

`}),e.add({id:2322,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

Inherits from:

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id

`}),e.add({id:2323,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id

`}),e.add({id:2324,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

Inherits from:

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Description
PeerId	peer id

`}),e.add({id:2325,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Description
PeerId	peer id

`}),e.add({id:2326,href:"https://www.4players.io/odin/sdk/unity/classes/peerlefteventargs/",title:"PeerLeftEventArgs",section:"ODIN Documentation",description:" Arguments for PeerLeft events in the current room ",content:`

Inherits from:

public class PeerLeftEventArgs : EventArgs

Arguments for PeerLeft events in the current room

Properties

Name	Description
PeerId	peer id

`}),e.add({id:2327,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2328,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2329,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2330,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2331,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2332,href:"https://www.4players.io/odin/sdk/unity/classes/peerleftproxy/",title:"PeerLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerLeftProxy : UnityEvent<object, PeerLeftEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2333,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/peerleftremovecomponent/",title:"PeerLeftRemoveComponent",section:"ODIN Documentation",description:"",content:`

public void PeerLeftRemoveComponent(object sender, PeerLeftEventArgs args)

Removes all child components with the same peer id

Parameters

Name	Type	Description
sender	Object	OdinRoom object
args	PeerLeftEventArgs	left peer data

`}),e.add({id:2334,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/peerrpc/",title:"PeerRpc",section:"ODIN Documentation",description:" Client/Remote peer ",content:`

public struct PeerRpc

Client/Remote peer

Properties

Name	Description
Id	peer id
UserId	token user id
UserData	peer userdata
Medias	peer decoders

`}),e.add({id:2335,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool PeerUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2336,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool PeerUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2337,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2338,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2339,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2340,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2341,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2342,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2343,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool PeerUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2344,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/peerupdatedevent/",title:"PeerUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool PeerUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2345,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/peeruserdatachanged/",title:"PeerUserDataChanged",section:"ODIN Documentation",description:"Fired when the user data of a remote peer changed.",content:`

public PeerUserDataChanged: OdinPeerUserDataChangedEvent

Fired when the user data of a remote peer changed.

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
UserData	UserData	peer userdata

`}),e.add({id:2348,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peeruserdatachangedeventargs/",title:"PeerUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerUserDataChanged events in the current room ",content:`

Inherits from:

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
UserData	UserData	peer userdata

`}),e.add({id:2349,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peeruserdatachangedeventargs/",title:"PeerUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerUserDataChanged events in the current room ",content:`

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Type	Description
PeerId	UInt64	peer id
Peer	Peer	peer object
UserData	UserData	peer userdata

`}),e.add({id:2350,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peeruserdatachangedeventargs/",title:"PeerUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerUserDataChanged events in the current room ",content:`

Inherits from:

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Description
PeerId	peer id
Peer	peer object
UserData	peer userdata

`}),e.add({id:2351,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peeruserdatachangedeventargs/",title:"PeerUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerUserDataChanged events in the current room ",content:`

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Description
PeerId	peer id
Peer	peer object
UserData	peer userdata

`}),e.add({id:2352,href:"https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedeventargs/",title:"PeerUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for PeerUserDataChanged events in the current room ",content:`

Inherits from:

public class PeerUserDataChangedEventArgs : EventArgs

Arguments for PeerUserDataChanged events in the current room

Properties

Name	Description
PeerId	peer id
Peer	peer object
UserData	peer userdata

`}),e.add({id:2353,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2354,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2355,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2356,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2357,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2358,href:"https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedproxy/",title:"PeerUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class PeerUserDataChangedProxy : UnityEvent<object, PeerUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2359,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/pipeline/",title:"Pipeline",section:"ODIN Documentation",description:" Odin effect pipeline ",content:`

public MediaPipeline Pipeline { get; set; }

Odin effect pipeline

Value Type

Type	Description
MediaPipeline

`}),e.add({id:2360,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/pipeline/",title:"Pipeline",section:"ODIN Documentation",description:" Odin effect pipeline ",content:`

public MediaPipeline Pipeline { get; set; }

Odin effect pipeline

Value Type

Type	Description
MediaPipeline

`}),e.add({id:2361,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/",title:"PiplineEffect",section:"ODIN Documentation",description:"",content:`

public abstract class PiplineEffect : IPiplineEffect

Constructors

Name	Description
PiplineEffect(OdinPipelineHandle, UInt32)

Properties

Name	Description
Id	Effect id
Index	Effect index
Parent	Pipeline handle

Public Methods

Name	Description
GetEffectIndex	Get native effect index
GetEffectType	Get native effect NativeBindings
GetVadConfig	Get native voice activity config
SetApmConfig	Set native audio processing config
SetApmStreamDelay	Set native audio processing delay
SetVadConfig	Set native voice activity config
UpdateApmPlayback	Send samples for native audio processing

`}),e.add({id:2362,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/constructor_0/",title:"PiplineEffect(OdinPipelineHandle, UInt32)",section:"ODIN Documentation",description:"",content:`

public PiplineEffect(OdinPipelineHandle parentHandle, uint effectId)

Parameters

Name	Description
parentHandle
effectId

`}),e.add({id:2363,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2364,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2365,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2366,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2367,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2368,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2369,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2370,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2371,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2372,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2373,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/platform/",title:"Platform",section:"ODIN Documentation",description:" Platform the library is running on ",content:`

public static SupportedPlatform Platform { get; }

Platform the library is running on

Info

This value is used to determine how the native ODIN runtime library will loaded and unloaded.

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2374,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/platform/",title:"Platform",section:"ODIN Documentation",description:" Determines which platform specific code needs to be executed ",content:`

public SupportedPlatform Platform { get; set; }

Determines which platform specific code needs to be executed

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:2375,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/playback/",title:"Playback",section:"ODIN Documentation",description:" Actual Unity audio output component ",content:`

public AudioSource Playback

Actual Unity audio output component

Value Type

Type	Description
AudioSource

`}),e.add({id:2376,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/playbackaudiomixer/",title:"PlaybackAudioMixer",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public AudioMixer PlaybackAudioMixer

Value Type

Type	Description
AudioMixer

`}),e.add({id:2377,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/playbackaudiomixer/",title:"PlaybackAudioMixer",section:"ODIN Documentation",description:"",content:`

public AudioMixer PlaybackAudioMixer

Value Type

Type	Description
AudioMixer

`}),e.add({id:2378,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/playbackaudiomixer/",title:"PlaybackAudioMixer",section:"ODIN Documentation",description:"",content:`

public AudioMixer PlaybackAudioMixer

Value Type

Type	Description
AudioMixer

`}),e.add({id:2379,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/playbackaudiomixer/",title:"PlaybackAudioMixer",section:"ODIN Documentation",description:"",content:`

public AudioMixer PlaybackAudioMixer

Value Type

Type	Description
AudioMixer

`}),e.add({id:2380,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/playbackaudiomixer/",title:"PlaybackAudioMixer",section:"ODIN Documentation",description:"",content:`

public AudioMixer PlaybackAudioMixer

Value Type

Type	Description
AudioMixer

`}),e.add({id:2381,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/playbackaudiomixergroup/",title:"PlaybackAudioMixerGroup",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public AudioMixerGroup PlaybackAudioMixerGroup

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:2382,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/playbackaudiomixergroup/",title:"PlaybackAudioMixerGroup",section:"ODIN Documentation",description:"",content:`

public AudioMixerGroup PlaybackAudioMixerGroup

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:2383,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/playbackaudiomixergroup/",title:"PlaybackAudioMixerGroup",section:"ODIN Documentation",description:"",content:`

public AudioMixerGroup PlaybackAudioMixerGroup

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:2384,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/playbackaudiomixergroup/",title:"PlaybackAudioMixerGroup",section:"ODIN Documentation",description:"",content:`

public AudioMixerGroup PlaybackAudioMixerGroup

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:2385,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/playbackaudiomixergroup/",title:"PlaybackAudioMixerGroup",section:"ODIN Documentation",description:"",content:`

public AudioMixerGroup PlaybackAudioMixerGroup

Value Type

Type	Description
AudioMixerGroup

`}),e.add({id:2386,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/",title:"PlaybackComponent",section:"ODIN Documentation",description:" Handles the Playback for received ODIN audio data. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Discussion

Properties

Name	Type	Description
PlaybackSource	AudioSource	The Unity AudioSource component for playback
Mute	Boolean	The Unity AudioSource mute property
MuteStream	Boolean	The Odin PlaybackStream underlying media stream calls
RoomName	String	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
PeerId	UInt64	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
MediaStreamId	Int64	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
AutoDestroyAudioSource	Boolean	On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources
AutoDestroyMediaStream	Boolean	On true destroy the Media in dispose to not leak or false for manually manage stream
OverrideSampleRate	Boolean	Use set RemoteSampleRate on false
SampleRate	MediaSampleRate	The playback Core
HasActivity	Boolean

Example

`}),e.add({id:2387,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/",title:"PlaybackComponent",section:"ODIN Documentation",description:" Handles the Playback for received ODIN audio data. ",content:`

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Discussion

Properties

Name	Type	Description
PlaybackSource	AudioSource	The Unity AudioSource component for playback
AutoDestroyAudioSource	Boolean	On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources
AutoDestroyMediaStream	Boolean	On true destroy the Media in dispose to not leak or false for manually manage stream
SampleRate	MediaSampleRate	The playback Core
Mute	Boolean	The Unity AudioSource mute property
RoomName	String	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
PeerId	UInt64	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
MediaStreamId	Int64	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
HasActivity	Boolean

Public Methods

Name	Description
GetOdinAudioStreamStats

Example

`}),e.add({id:2388,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/",title:"PlaybackComponent",section:"ODIN Documentation",description:" Handles the Playback for received ODIN audio data. ",content:`

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Discussion

Properties

Name	Type	Description
PlaybackSource	AudioSource	The Unity AudioSource component for playback
AutoDestroyAudioSource	Boolean	On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources
AutoDestroyMediaStream	Boolean	On true destroy the Media in dispose to not leak or false for manually manage stream
SampleRate	MediaSampleRate	The playback Core
Mute	Boolean	The Unity AudioSource mute property
RoomName	String	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
PeerId	UInt64	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
MediaStreamId	Int64	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
HasActivity	Boolean

Public Methods

Name	Description
GetOdinAudioStreamStats

Example

`}),e.add({id:2389,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/",title:"PlaybackComponent",section:"ODIN Documentation",description:" Handles the Playback for received ODIN audio data. ",content:`

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Properties

Name	Description
PlaybackSource	The Unity AudioSource component for playback
AutoDestroyAudioSource	On true destroy the PlaybackComponent in dispose to not leak (AudioSource) or false for manually manage sources
AutoDestroyMediaStream	On true destroy the Media in dispose to not leak or false for manually manage stream
SampleRate	The playback Core
Mute	The Unity AudioSource mute property
RoomName	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
PeerId	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
MediaStreamId	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
HasActivity

Public Methods

Name	Description
SetMediaInfo
GetOdinAudioStreamStats

`}),e.add({id:2390,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/",title:"PlaybackComponent",section:"ODIN Documentation",description:" Handles the Playback for received ODIN audio data. ",content:`

public class PlaybackComponent : MonoBehaviour

Handles the Playback for received ODIN audio data.

Discussion

The PlaybackComponent is the heart of ODIN within Unity. It connects a Unity AudioSource with an ODIN room which runs on ODIN servers either hosted by 4Players or self-hosted.

Warning

Important: Don’t create this component yourself and don’t attach it in the Unity editor manually to components. Use the method AddPlaybackComponent from OdinHandler.Instance to create this component.

The component receives the audio stream of the server and “injects” it into the AudioSource .

Properties

Name	Description
PlaybackSource	The Unity AudioSource component for playback
AutoDestroyAudioSource	On true destroy the PlaybackSource in dispose to not leak (AudioSource) or false for manually manage sources
AutoDestroyMediaStream	On true destroy the Media in dispose to not leak or false for manually manage stream
SampleRate	The playback Core
Mute	The Unity AudioSource mute property
RoomName	Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.
PeerId	Peer id for this playback. Change this value to change the PlaybackStream by RemotePeers in the Room.
MediaStreamId	Media id for this playback. Change this value to pick a PlaybackStream by media id from peers Medias.
HasActivity

Public Methods

Name	Description
SetMediaInfo
GetOdinAudioStreamStats

Example

PlaybackComponent Example

using OdinNative.Odin;
using OdinNative.Odin.Room;
using OdinNative.Unity;
using OdinNative.Unity.Audio;
using UnityEngine;

public class MyOdinPeerManager : MonoBehaviour
{
    private void AttachOdinPlaybackToPlayer(PlayerScript player, Room room, ulong peerId, int mediaId)
    {
        // Create the PlaybackComponent and AudioSource at the players gameObject
        PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(player.gameObject, room.Config.Name, peerId, mediaId);

        // Setup the Playback Component
        playback.CheckPlayingStatusAsInvoke = true; // set checking status as MonoBehaviour.InvokeRepeating active
        playback.PlayingStatusDelay = 1.0f; // (default 0f)
        playback.PlayingStatusRepeatingTime = 0.3f; // (default 0.2f)

        // Make the AudioSource a 3D source (use 0.0 if the volume should be the same regardless of position to the camera)
        playback.PlaybackSource.spatialBlend = 1.0f; // set AudioSource to full 3D
    }

    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        // Called if a peer has started to send audio
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Use the User Data to to map the ODIN peer to the player in the network
        CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
        PlayerScript player = GetPlayerForOdinPeer(userData);
        if (player)
        {
            // We have found a player, attach the ODIN audio to that player
            AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }
}

`}),e.add({id:2391,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/playbackmediaconfig/",title:"PlaybackMediaConfig",section:"ODIN Documentation",description:" Configuration for on new medias ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public OdinMediaConfig PlaybackMediaConfig

Configuration for Media on new medias

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:2392,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/playbackmediaconfig/",title:"PlaybackMediaConfig",section:"ODIN Documentation",description:" Configuration for on new medias ",content:`

public OdinMediaConfig PlaybackMediaConfig

Configuration for Media on new medias

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:2393,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/playbackmediaconfig/",title:"PlaybackMediaConfig",section:"ODIN Documentation",description:" Configuration for on new medias ",content:`

public OdinMediaConfig PlaybackMediaConfig

Configuration for Media on new medias

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:2394,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/playbackmediaconfig/",title:"PlaybackMediaConfig",section:"ODIN Documentation",description:" Configuration for on new medias ",content:`

public OdinMediaConfig PlaybackMediaConfig

Configuration for Media on new medias

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:2395,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/playbackmediaconfig/",title:"PlaybackMediaConfig",section:"ODIN Documentation",description:" Configuration for on new medias ",content:`

public OdinMediaConfig PlaybackMediaConfig

Configuration for Media on new medias

Value Type

Type	Description
OdinMediaConfig

`}),e.add({id:2396,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/playbackmedias/",title:"PlaybackMedias",section:"ODIN Documentation",description:" Get all medias of room peers ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IEnumerable<MediaCollection> PlaybackMedias { get; }

Get all medias of room peers

Value Type

Type	Description
IEnumerable<MediaCollection>

`}),e.add({id:2397,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/playbackmedias/",title:"PlaybackMedias",section:"ODIN Documentation",description:" Get all medias of room peers ",content:`

public IEnumerable<MediaCollection> PlaybackMedias { get; }

Get all medias of room peers

Value Type

Type	Description
IEnumerable<MediaCollection>

`}),e.add({id:2398,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/playbackmedias/",title:"PlaybackMedias",section:"ODIN Documentation",description:" Get all medias of room peers ",content:`

public IEnumerable<MediaCollection> PlaybackMedias { get; }

Get all medias of room peers

Value Type

Type	Description
IEnumerable<MediaCollection>

`}),e.add({id:2399,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/playbackmedias/",title:"PlaybackMedias",section:"ODIN Documentation",description:" Get all medias of room peers ",content:`

public IEnumerable<MediaCollection> PlaybackMedias { get; }

Get all medias of room peers

Value Type

Type	Description
IEnumerable<MediaCollection>

`}),e.add({id:2400,href:"https://www.4players.io/odin/sdk/unity/classes/room/playbackmedias/",title:"PlaybackMedias",section:"ODIN Documentation",description:" Get all medias of room peers ",content:`

public IEnumerable<MediaCollection> PlaybackMedias { get; }

Get all medias of room peers

Value Type

Type	Description
IEnumerable<MediaCollection>

`}),e.add({id:2401,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/playbacksource/",title:"PlaybackSource",section:"ODIN Documentation",description:" The Unity AudioSource component for playback ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public AudioSource PlaybackSource

The Unity AudioSource component for playback

Info

Unity controls the playback device: no ConfigurationChanged event

Value Type

Type	Description
AudioSource

`}),e.add({id:2402,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/playbacksource/",title:"PlaybackSource",section:"ODIN Documentation",description:" The Unity AudioSource component for playback ",content:`

public AudioSource PlaybackSource

The Unity AudioSource component for playback

Info

Unity controls the playback device: no ConfigurationChanged event

Value Type

Type	Description
AudioSource

`}),e.add({id:2403,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/playbacksource/",title:"PlaybackSource",section:"ODIN Documentation",description:" The Unity AudioSource component for playback ",content:`

public AudioSource PlaybackSource

The Unity AudioSource component for playback

Info

Unity controls the playback device: no ConfigurationChanged event

Value Type

Type	Description
AudioSource

`}),e.add({id:2404,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/playbacksource/",title:"PlaybackSource",section:"ODIN Documentation",description:" The Unity AudioSource component for playback ",content:`

public AudioSource PlaybackSource

The Unity AudioSource component for playback

Info

Unity controls the playback device: no ConfigurationChanged event

Value Type

Type	Description
AudioSource

`}),e.add({id:2405,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/playbacksource/",title:"PlaybackSource",section:"ODIN Documentation",description:" The Unity AudioSource component for playback ",content:`

public AudioSource PlaybackSource

The Unity AudioSource component for playback

Info

Unity controls the playback device: no ConfigurationChanged event

Value Type

Type	Description
AudioSource

`}),e.add({id:2406,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstats/",title:"PlaybackStats",section:"ODIN Documentation",description:"",content:`

public class PlaybackStats : MonoBehaviour

Properties

Name	Type	Description
Log	Boolean
PauseAnimationCurve	Boolean
PacketsProcessed	UInt32
PacketsDroppedEarly	UInt32
PacketsDroppedLate	UInt32
PacketsLost	UInt32
PacketsAvailableDifference	AnimationCurve

`}),e.add({id:2407,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstats/",title:"PlaybackStats",section:"ODIN Documentation",description:"",content:`

public class PlaybackStats : MonoBehaviour

Properties

Name	Type	Description
Log	Boolean
PauseAnimationCurve	Boolean
PacketsProcessed	UInt32
PacketsDroppedEarly	UInt32
PacketsDroppedLate	UInt32
PacketsLost	UInt32
PacketsAvailableDifference	AnimationCurve

`}),e.add({id:2408,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstats/",title:"PlaybackStats",section:"ODIN Documentation",description:"",content:`

public class PlaybackStats : MonoBehaviour

Properties

Name	Description
Log
PauseAnimationCurve
PacketsProcessed
PacketsDroppedEarly
PacketsDroppedLate
PacketsLost
PacketsAvailableDifference

`}),e.add({id:2409,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstats/",title:"PlaybackStats",section:"ODIN Documentation",description:"",content:`

public class PlaybackStats : MonoBehaviour

Properties

Name	Description
Log
PauseAnimationCurve
PacketsProcessed
PacketsDroppedEarly
PacketsDroppedLate
PacketsLost
PacketsAvailableDifference

`}),e.add({id:2410,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackstream/",title:"PlaybackStream",section:"ODIN Documentation",description:" Representation of a read only audio stream ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Inherits from: MediaStream

public class PlaybackStream : MediaStream, IVideoStream, IAudioStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:2411,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackstream/",title:"PlaybackStream",section:"ODIN Documentation",description:" Representation of a read only audio stream ",content:`

Inherits from: MediaStream

public class PlaybackStream : MediaStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioReset	This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Boolean	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:2412,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackstream/",title:"PlaybackStream",section:"ODIN Documentation",description:" Representation of a read only audio stream ",content:`

Inherits from: MediaStream

public class PlaybackStream : MediaStream, IVideoStream, IAudioStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!

Inherited Properties

Name	Type	Description
Id	Int64	Handle ID
MediaConfig	OdinMediaConfig	Audio config of the media stream
CancellationSource	CancellationTokenSource	Control of async read and write tasks
IsPaused	Boolean	Indicates wether or not the media stream is paused
IsMuted	Boolean	Indicates wether or not the media stream is muted
IsActive	Boolean	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Boolean
IsInvalid	Boolean

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
SetPause	Sets IsPaused.
TogglePause	Toggles IsPaused.
SetMute	Sets IsMuted.
ToggleMute	Toggles IsMuted.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReadData	Reads data from the audio stream.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioDataLength	Get the number of samples available in the audio buffer.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:2413,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackstream/",title:"PlaybackStream",section:"ODIN Documentation",description:" Representation of a read only audio stream ",content:`

Inherits from: MediaStream

public class PlaybackStream : MediaStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioReset	This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Inherited Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:2414,href:"https://www.4players.io/odin/sdk/unity/classes/playbackstream/",title:"PlaybackStream",section:"ODIN Documentation",description:" Representation of a read only audio stream ",content:`

Inherits from: MediaStream

public class PlaybackStream : MediaStream, IDisposable

Representation of a read only audio stream

Public Methods

Name	Description
AudioPushData	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataTask	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioPushDataAsync	AudioPushDataTask and AudioPushDataAsync are not supported!
AudioReset	This operation resets the internal Opus encoder/decoder, ensuring a clean state. Additionally, it clears internal buffers, providing a fresh start.

Inherited Properties

Name	Description
Id	Handle ID
MediaConfig	Audio config of the media stream
CancellationSource	Control of async read and write tasks
IsActive	Indicates wether or not the media stream is active and sending/receiving data
HasErrors	Indicates wether or not the last media stream api call result is an error code
IsInvalid	Indicates wether or not the media stream handle is invalid or closed

Inherited Methods

Name	Description
GetMediaId	Returns the media stream ID and updates Id.
GetPeerId	Returns the ID of the peer that own this media stream.
AudioPushData	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataTask	Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
AudioPushDataAsync	Sends audio data using a custom CancellationSource. The data has to be interleaved [-1, 1] float data.
AudioReset
AudioReadData	Reads data from the audio stream.
AudioStats	Retrieves statistics for the specified Media.
AudioReadDataTask	Reads data from the audio stream.
AudioReadDataAsync	Read audio data using a custom custom CancellationSource.
AudioResample	Set a resampler and resamples a chunk of audio.
Cancel	Cancel the custom CancellationSource.
ToString	Debug
Dispose	On dispose will free the stream and resampler

`}),e.add({id:2415,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/pop/",title:"Pop",section:"ODIN Documentation",description:"",content:`

public bool Pop(OdinMediaData audio)

Pop output audio from the media

Parameters

Name	Type	Description
audio	OdinMediaData	samples

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2416,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/pop/",title:"Pop",section:"ODIN Documentation",description:"",content:`

public OdinError Pop(out NativeBindings.OdinDatagramSend datagram)

Pop one datagram from the media

Parameters

Name	Type	Description
datagram	OdinDatagramSend

Returns

Type	Description
OdinError	/ or error

`}),e.add({id:2417,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/popall/",title:"PopAll",section:"ODIN Documentation",description:"",content:`

public bool PopAll(ref ConcurrentStack<NativeBindings.OdinDatagramSend> datagrams)

Pop all audio datagrams into the stack

Parameters

Name	Type	Description
datagrams	ConcurrentStack<OdinDatagramSend>	datagram stack

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2418,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/position/",title:"position",section:"ODIN Documentation",description:"The current three-dimensional position of our own `OdinPeer` in the room.",content:`

any

The current three-dimensional position of our own OdinPeer in the room.

`}),e.add({id:2419,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/positionx/",title:"PositionX",section:"ODIN Documentation",description:" Inital position of self on join ",content:`

public float PositionX { get; }

Inital position of self on join

Value Type

Type	Description
Single

`}),e.add({id:2420,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/positiony/",title:"PositionY",section:"ODIN Documentation",description:" Inital position of self on join ",content:`

public float PositionY { get; }

Inital position of self on join

Value Type

Type	Description
Single

`}),e.add({id:2421,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/positionz/",title:"PositionZ",section:"ODIN Documentation",description:" Inital position of self on join ",content:`

public float PositionZ { get; }

Inital position of self on join

Value Type

Type	Description
Single

`}),e.add({id:2422,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2423,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2424,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2425,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2426,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2427,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/possiblenativebinarylocations/",title:"PossibleNativeBinaryLocations",section:"ODIN Documentation",description:" Possible install location of the native ODIN runtime binary ",content:`

public string[] PossibleNativeBinaryLocations { get; set; }

Possible install location of the native ODIN runtime binary

Value Type

Type	Description
String[]

`}),e.add({id:2428,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/pre_amplifier/",title:"pre_amplifier",section:"ODIN Documentation",description:"",content:`

public bool pre_amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2429,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/preamplifier/",title:"preAmplifier",section:"ODIN Documentation",description:"Enable or disable the pre amplifier",content:`

public preAmplifier: boolean

Enable or disable the pre amplifier

`}),e.add({id:2430,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2431,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Amplifies the audio input ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool PreAmplifier

Amplifies the audio input

Value Type

Type	Description
Boolean

`}),e.add({id:2432,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Enable or disable the pre amplifier ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool PreAmplifier { get; set; }

Enable or disable the pre amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2433,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2434,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Amplifies the audio input ",content:`

public bool PreAmplifier

Amplifies the audio input

Value Type

Type	Description
Boolean

`}),e.add({id:2435,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Enable or disable the pre amplifier ",content:`

public bool PreAmplifier { get; set; }

Enable or disable the pre amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2436,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2437,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Amplifies the audio input ",content:`

public bool PreAmplifier

Amplifies the audio input

Value Type

Type	Description
Boolean

`}),e.add({id:2438,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Enable or disable the pre amplifier ",content:`

public bool PreAmplifier { get; set; }

Enable or disable the pre amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2439,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2440,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Amplifies the audio input ",content:`

public bool PreAmplifier

Amplifies the audio input

Value Type

Type	Description
Boolean

`}),e.add({id:2441,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Enable or disable the pre amplifier ",content:`

public bool PreAmplifier { get; set; }

Enable or disable the pre amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2442,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled ",content:`

public bool PreAmplifier { get; set; }

Idicates whether the ApmConfig setting is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:2443,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:"",content:`

public bool PreAmplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2444,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2445,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool PreAmplifier

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2446,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Amplifies the audio input ",content:`

public bool PreAmplifier

Amplifies the audio input

Value Type

Type	Description
Boolean

`}),e.add({id:2447,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/preamplifier/",title:"PreAmplifier",section:"ODIN Documentation",description:" Enable or disable the pre amplifier ",content:`

public bool PreAmplifier { get; set; }

Enable or disable the pre amplifier

Value Type

Type	Description
Boolean

`}),e.add({id:2448,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/processrpc/",title:"ProcessRPC",section:"ODIN Documentation",description:"",content:`

public virtual void ProcessRPC(byte[] bytes)

Will process all rpc packets.

Info

Client side processing of MsgPackMessageType is not supported and will always response with "MessagePack requests are not supported!" or drop the request on error

Parameters

Name	Type	Description
bytes	Byte[]	raw Msgpack

`}),e.add({id:2449,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/mediarpc/properties/",title:"Properties",section:"ODIN Documentation",description:" arbitrary media data ",content:`

public MediaRpcProperties Properties

arbitrary media data

Value Type

Type	Description
MediaRpcProperties

`}),e.add({id:2450,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/proxyaudio/",title:"ProxyAudio",section:"ODIN Documentation",description:"",content:`

public virtual void ProxyAudio(float[] buffer, int position, bool isSilent = false)

Redirects audio to all media encoders in the corresponding room.

Parameters

Name	Type	Description
buffer	Single[]
position	Int32
isSilent	Boolean

`}),e.add({id:2451,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/push/",title:"Push",section:"ODIN Documentation",description:"",content:`

public bool Push(NativeBindings.OdinDatagramRecv datagram)

Push output audio into the media for effect processing

Parameters

Name	Type	Description
datagram	OdinDatagramRecv	samples

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2452,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/push/",title:"Push",section:"ODIN Documentation",description:"",content:`

public OdinError Push(float[] samples, bool isSilent = false)

Push samples to the media

Parameters

Name	Type	Description
samples	Single[]	audio samples
isSilent	Boolean	flag samples as silence

Returns

Type	Description
OdinError	or error

`}),e.add({id:2453,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	MediaSampleRate	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2454,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	MediaSampleRate	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2455,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	MediaSampleRate	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2456,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	MediaSampleRate	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2457,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

public static int RateToSamples(uint sampleRate = 48000U, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	UInt32	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2458,href:"https://www.4players.io/odin/sdk/unity/classes/utility/ratetosamples/",title:"RateToSamples",section:"ODIN Documentation",description:"",content:`

public static int RateToSamples(MediaSampleRate sampleRate = MediaSampleRate.Hz48000, int ms = 20)

Get sample size by samplerate and time

Parameters

Name	Type	Description
sampleRate	MediaSampleRate	samplerate in hz
ms	Int32	time in milliseconds

Returns

Type	Description
Int32	sample size

`}),e.add({id:2459,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/readodinaudiodata/",title:"ReadOdinAudioData",section:"ODIN Documentation",description:"",content:`

public virtual void ReadOdinAudioData()

`}),e.add({id:2460,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinconnectionstatechangedeventpayload/reason/",title:"reason",section:"ODIN Documentation",description:"The error code if the connection state is Error.",content:`

public reason: OdinConnectionStateChangeReason

The error code if the connection state is Error.

Value Type

Type	Description
Boolean

`}),e.add({id:2462,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/redirectcapturedaudio/",title:"RedirectCapturedAudio",section:"ODIN Documentation",description:" Skips registered PushAudio for the OnMicrophoneData event ",content:`

public bool RedirectCapturedAudio

Skips registered PushAudio for the OnMicrophoneData event

Info

This will stop progress of time in the audio pipeline and can result in missing event updates like OnMediaActiveStateChanged. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2463,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/redirectcapturedaudio/",title:"RedirectCapturedAudio",section:"ODIN Documentation",description:" Skips registered PushAudio for the OnMicrophoneData event ",content:`

public bool RedirectCapturedAudio

Skips registered PushAudio for the OnMicrophoneData event

Info

This will stop progress of time in the audio pipeline and can result in missing event updates like OnMediaActiveStateChanged. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2464,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/redirectcapturedaudio/",title:"RedirectCapturedAudio",section:"ODIN Documentation",description:" Skips registered PushAudio for the OnMicrophoneData event ",content:`

public bool RedirectCapturedAudio

Skips registered PushAudio for the OnMicrophoneData event

Info

This will stop progress of time in the audio pipeline and can result in missing event updates like OnMediaActiveStateChanged. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2465,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/redirectcapturedaudio/",title:"RedirectCapturedAudio",section:"ODIN Documentation",description:" Skips registered PushAudio for the OnMicrophoneData event ",content:`

public bool RedirectCapturedAudio

Skips registered PushAudio for the OnMicrophoneData event

Info

This will stop progress of time in the audio pipeline and can result in missing event updates like OnMediaActiveStateChanged. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2466,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/redirectcapturedaudio/",title:"RedirectCapturedAudio",section:"ODIN Documentation",description:" Skips registered PushAudio for the OnMicrophoneData event ",content:`

public bool RedirectCapturedAudio

Skips registered PushAudio for the OnMicrophoneData event

Info

This will stop progress of time in the audio pipeline and can result in missing event updates like OnMediaActiveStateChanged. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2467,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/redirectinputaudio/",title:"RedirectInputAudio",section:"ODIN Documentation",description:" Skips registered PushAudio ",content:`

public bool RedirectInputAudio

Skips registered PushAudio

Info

This will stop progress of time in the audio pipeline and can result in missing event updates. Should only be disabled if handled.

Value Type

Type	Description
Boolean

`}),e.add({id:2468,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2469,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2470,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2471,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2472,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2473,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibrary/release/",title:"Release",section:"ODIN Documentation",description:"",content:`

public static void Release()

Releases the unmanaged resources used by the Core-Instance

`}),e.add({id:2474,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinsensitivityconfig/release_threshold/",title:"release_threshold",section:"ODIN Documentation",description:" when the trigger should disengage ",content:`

public float release_threshold

when the trigger should disengage

Value Type

Type	Description
Single

`}),e.add({id:2475,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/remote/",title:"remote",section:"ODIN Documentation",description:"Indicates wether or not the media belongs to a remote peer.",content:`

boolean

Indicates wether or not the media belongs to a remote peer.

`}),e.add({id:2476,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/remote/",title:"remote",section:"ODIN Documentation",description:"Indicates, whether the peer is a remote peer or not.",content:`

boolean

Indicates, whether the peer is a remote peer or not.

`}),e.add({id:2477,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback default Channel ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static MediaChannels RemoteChannels { get; set; }

Playback default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:2478,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback Channels ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaChannels RemoteChannels

Playback Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2479,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback default Channel ",content:`

public static MediaChannels RemoteChannels { get; set; }

Playback default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:2480,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback Channels ",content:`

public MediaChannels RemoteChannels

Playback Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2481,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback default Channel ",content:`

public static MediaChannels RemoteChannels { get; set; }

Playback default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:2482,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback Channels ",content:`

public MediaChannels RemoteChannels

Playback Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2483,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback default Channel ",content:`

public static MediaChannels RemoteChannels { get; set; }

Playback default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:2484,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback Channels ",content:`

public MediaChannels RemoteChannels

Playback Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2485,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback default Channel ",content:`

public static MediaChannels RemoteChannels { get; set; }

Playback default Channel

Value Type

Type	Description
MediaChannels

`}),e.add({id:2486,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/remotechannels/",title:"RemoteChannels",section:"ODIN Documentation",description:" Playback Channels ",content:`

public MediaChannels RemoteChannels

Playback Channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2487,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/remotepeers/",title:"remotePeers",section:"ODIN Documentation",description:"A map of all remote `OdinPeer` instances in the room using the peer ID as index.",content:`

Map<number><OdinPeer>

A map of all remote OdinPeer instances in the room using the peer ID as index.

Value Type

Type	Description
PeerCollection

`}),e.add({id:2489,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/remotepeers/",title:"RemotePeers",section:"ODIN Documentation",description:" Conatiner of room peers ",content:`

public PeerCollection RemotePeers { get; }

Conatiner of room peers

Value Type

Type	Description
PeerCollection

`}),e.add({id:2490,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/remotepeers/",title:"RemotePeers",section:"ODIN Documentation",description:" Conatiner of room peers ",content:`

public PeerCollection RemotePeers { get; }

Conatiner of room peers

Value Type

Type	Description
PeerCollection

`}),e.add({id:2491,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/remotepeers/",title:"RemotePeers",section:"ODIN Documentation",description:" Conatiner of room peers ",content:`

public PeerCollection RemotePeers { get; }

Conatiner of room peers

Value Type

Type	Description
PeerCollection

`}),e.add({id:2492,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/remotepeers/",title:"RemotePeers",section:"ODIN Documentation",description:" Conatiner of room peers ",content:`

public ConcurrentDictionary<ulong, PeerEntity> RemotePeers { get; }

Conatiner of room peers

Value Type

Type	Description
ConcurrentDictionary<UInt64,PeerEntity>

`}),e.add({id:2493,href:"https://www.4players.io/odin/sdk/unity/classes/room/remotepeers/",title:"RemotePeers",section:"ODIN Documentation",description:" Conatiner of room peers ",content:`

public PeerCollection RemotePeers { get; }

Conatiner of room peers

Value Type

Type	Description
PeerCollection

`}),e.add({id:2494,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback default Sample-Rate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static MediaSampleRate RemoteSampleRate { get; set; }

Playback default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2495,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback Sample-Rate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaSampleRate RemoteSampleRate

Playback Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2496,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback default Sample-Rate ",content:`

public static MediaSampleRate RemoteSampleRate { get; set; }

Playback default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2497,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback Sample-Rate ",content:`

public MediaSampleRate RemoteSampleRate

Playback Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2498,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback default Sample-Rate ",content:`

public static MediaSampleRate RemoteSampleRate { get; set; }

Playback default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2499,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback Sample-Rate ",content:`

public MediaSampleRate RemoteSampleRate

Playback Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2500,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback default Sample-Rate ",content:`

public static MediaSampleRate RemoteSampleRate { get; set; }

Playback default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2501,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback Sample-Rate ",content:`

public MediaSampleRate RemoteSampleRate

Playback Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2502,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback default Sample-Rate ",content:`

public static MediaSampleRate RemoteSampleRate { get; set; }

Playback default Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2503,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/remotesamplerate/",title:"RemoteSampleRate",section:"ODIN Documentation",description:" Playback Sample-Rate ",content:`

public MediaSampleRate RemoteSampleRate

Playback Sample-Rate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2504,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Remove(long id)
public bool Remove(MediaStream item)

Remove a stream by handle id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(long id)

Remove a stream by handle id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(MediaStream item)

Remove a stream from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2505,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peercollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Remove(ulong id)
public bool Remove(Peer item)

Remove a peer by id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(ulong id)

Remove a peer by id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(Peer item)

Remove a peer from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2506,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Remove(string key)
public bool Remove(Room item)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name
item	Room	room

Returns

Type	Description
Boolean	is removed

Variants

Remove(key)

public bool Remove(string key)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name

Returns

Type	Description
Boolean	is removed

Remove(item)

public bool Remove(Room item)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2507,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(long id)
public bool Remove(MediaStream item)

Remove a stream by handle id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(long id)

Remove a stream by handle id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(MediaStream item)

Remove a stream from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2508,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(ulong id)
public bool Remove(Peer item)

Remove a peer by id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(ulong id)

Remove a peer by id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(Peer item)

Remove a peer from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2509,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(string key)
public bool Remove(Room item)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name
item	Room	room

Returns

Type	Description
Boolean	is removed

Variants

Remove(key)

public bool Remove(string key)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name

Returns

Type	Description
Boolean	is removed

Remove(item)

public bool Remove(Room item)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2510,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(long id)
public bool Remove(MediaStream item)

Remove a stream by handle id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(long id)

Remove a stream by handle id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(MediaStream item)

Remove a stream from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2511,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peercollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(ulong id)
public bool Remove(Peer item)

Remove a peer by id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(ulong id)

Remove a peer by id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(Peer item)

Remove a peer from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2512,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(string key)
public bool Remove(Room item)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name
item	Room	room

Returns

Type	Description
Boolean	is removed

Variants

Remove(key)

public bool Remove(string key)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name

Returns

Type	Description
Boolean	is removed

Remove(item)

public bool Remove(Room item)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2513,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(long id)
public bool Remove(MediaStream item)

Remove a stream by handle id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(long id)

Remove a stream by handle id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(MediaStream item)

Remove a stream from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2514,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(ulong id)
public bool Remove(Peer item)

Remove a peer by id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(ulong id)

Remove a peer by id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(Peer item)

Remove a peer from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2515,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(string key)
public bool Remove(Room item)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name
item	Room	room

Returns

Type	Description
Boolean	is removed

Variants

Remove(key)

public bool Remove(string key)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name

Returns

Type	Description
Boolean	is removed

Remove(item)

public bool Remove(Room item)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2516,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(ulong id)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
id	UInt64

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2517,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(long id)
public bool Remove(MediaStream item)

Remove a stream by handle id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(long id)

Remove a stream by handle id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	Int64	handle id of the stream to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(MediaStream item)

Remove a stream from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	MediaStream	stream to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2518,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(ulong id)
public bool Remove(Peer item)

Remove a peer by id from the collection

Info

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

Variants

Remove(id)

public bool Remove(ulong id)

Remove a peer by id from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
id	UInt64	peer id of the peer to remove

Returns

Type	Description
Boolean	true on success or false

Remove(item)

public bool Remove(Peer item)

Remove a peer from the collection

Warning

Always false if the collection IsReadOnly

Parameters

Name	Type	Description
item	Peer	peer to remove

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2519,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/remove/",title:"Remove",section:"ODIN Documentation",description:"",content:`

public bool Remove(string key)
public bool Remove(Room item)

Removes the room from this collection

Info

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name
item	Room	room

Returns

Type	Description
Boolean	is removed

Variants

Remove(key)

public bool Remove(string key)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
key	String	Room name

Returns

Type	Description
Boolean	is removed

Remove(item)

public bool Remove(Room item)

Removes the room from this collection

Warning

does NOT leave or free the room

Parameters

Name	Type	Description
item	Room	room

Returns

Type	Description
Boolean	is removed

`}),e.add({id:2520,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/removedecoder/",title:"RemoveDecoder",section:"ODIN Documentation",description:"",content:`

public bool RemoveDecoder(ushort mediaId, out MediaDecoder decoder)

Remove the output media from PeerEntity

Parameters

Name	Type	Description
mediaId	UInt16	decoder id
decoder	MediaDecoder	output media that was removed

Returns

Type	Description
Boolean	true if removed or false

`}),e.add({id:2521,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/removedecoder/",title:"RemoveDecoder",section:"ODIN Documentation",description:"",content:`

public bool RemoveDecoder(ulong peerId, ushort mediaId, out MediaDecoder decoder)

Removes a output media from a remote peer.

Parameters

Name	Type	Description
peerId	UInt64	id of peer
mediaId	UInt16	id of a output media
decoder	MediaDecoder	output media that was removed

Returns

Type	Description
Boolean	true on decoder found or false

`}),e.add({id:2522,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediapipeline/removeeffect/",title:"RemoveEffect",section:"ODIN Documentation",description:"",content:`

public bool RemoveEffect(uint effectId)

Removes a effect from the native pipeline

Parameters

Name	Type	Description
effectId	UInt32	effect id

Returns

Type	Description
Boolean	true on removed or false

`}),e.add({id:2523,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/removeencoder/",title:"RemoveEncoder",section:"ODIN Documentation",description:"",content:`

public bool RemoveEncoder(ushort mediaId, out MediaEncoder encoder)

Removes the input media from Room

Parameters

Name	Type	Description
mediaId	UInt16	id of a input media
encoder	MediaEncoder	input media that was removed

Returns

Type	Description
Boolean	true on encoder found or false

`}),e.add({id:2524,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/removeeventlistener/",title:"removeEventListener",section:"ODIN Documentation",description:"Removes an event listener from the room for specific events.",content:`

public removeEventListener(eventName: Event): void

Removes an event listener from the room for specific events.

Parameters

Name	Type	Description
eventName	Event	The event to remove the listener from (see keys of OdinEvents for possible values)

Returns

Type	Description
void

`}),e.add({id:2525,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/removemedia/",title:"removeMedia",section:"ODIN Documentation",description:"Removes a media from the list of active medias and stops decoding.",content:`

removeMedia(media: OdinMedia): void

Removes a media from the list of active medias and stops decoding.

Parameters

Name	Type	Description
media	OdinMedia	The media instance to remove

Returns

Type	Description
void

`}),e.add({id:2526,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/removemedia/",title:"RemoveMedia",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool RemoveMedia(long mediaStreamId)

Remove a associated media from the peer

Parameters

Name	Type	Description
mediaStreamId	Int64	stream handle id

Returns

Type	Description
Boolean

`}),e.add({id:2527,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/removemedia/",title:"RemoveMedia",section:"ODIN Documentation",description:"",content:`

public bool RemoveMedia(long mediaStreamId)

Remove a associated media from the peer

Parameters

Name	Type	Description
mediaStreamId	Int64	stream handle id

Returns

Type	Description
Boolean

`}),e.add({id:2528,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/removemedia/",title:"RemoveMedia",section:"ODIN Documentation",description:"",content:`

public bool RemoveMedia(long mediaStreamId)

Remove a associated media from the peer

Parameters

Name	Type	Description
mediaStreamId	Int64	stream handle id

Returns

Type	Description
Boolean

`}),e.add({id:2529,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/removemedia/",title:"RemoveMedia",section:"ODIN Documentation",description:"",content:`

public bool RemoveMedia(long mediaStreamId)

Remove a associated media from the peer

Parameters

Name	Type	Description
mediaStreamId	Int64	stream handle id

Returns

Type	Description
Boolean

`}),e.add({id:2530,href:"https://www.4players.io/odin/sdk/unity/classes/peer/removemedia/",title:"RemoveMedia",section:"ODIN Documentation",description:"",content:`

public bool RemoveMedia(long mediaStreamId)

Remove a associated media from the peer

Parameters

Name	Type	Description
mediaStreamId	Int64	stream handle id

Returns

Type	Description
Boolean

`}),e.add({id:2531,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/removemediabyid/",title:"removeMediaById",section:"ODIN Documentation",description:"Removes a media from the list of active medias by the given ID and stops decoding.",content:`

removeMediaById(id: number): void

Removes a media from the list of active medias by the given ID and stops decoding.

Parameters

Name	Type	Description
id	number	The media ID to remove

Returns

Type	Description
void

`}),e.add({id:2532,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/removemediacomponent/",title:"RemoveMediaComponent",section:"ODIN Documentation",description:"",content:`

public bool RemoveMediaComponent(GameObject containerObject, ushort mediaId, bool componentOnly = false)

Removes all child components with the same media id

Parameters

Name	Type	Description
containerObject	GameObject	child components
mediaId	UInt16	decoder id
componentOnly	Boolean	on false will destroy gameobject

Returns

Type	Description
Boolean	true on removed decoder or false

`}),e.add({id:2533,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/removepeercomponent/",title:"RemovePeerComponent",section:"ODIN Documentation",description:"",content:`

public void RemovePeerComponent(GameObject containerObject)

Remove a Unity from a gameobject

Parameters

Name	Type	Description
containerObject	GameObject

`}),e.add({id:2534,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/request/",title:"Request",section:"ODIN Documentation",description:" Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md ",content:`

public static class Request

Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Properties

Name	Description
MsgidIndex	uint32 field (msgid)
MethodIndex	string field (method)
ParamsIndex	binary field (params)

`}),e.add({id:2535,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/msgpackmessagetype/request/",title:"Request",section:"ODIN Documentation",description:" Format: [type, msgid, method, params] ",content:`

Request = 0

Format: [type, msgid, method, params]

Value Type

Type	Description
MsgPackMessageType

`}),e.add({id:2536,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/resetbuffer/",title:"ResetBuffer",section:"ODIN Documentation",description:"",content:`

public void ResetBuffer()

`}),e.add({id:2537,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/reseteffect/",title:"ResetEffect",section:"ODIN Documentation",description:"",content:`

public void ResetEffect()
public void ResetEffect(MediaPipeline pipeline, uint samplerate, bool stereo, OdinApmConfig config)

Parameters

Name	Type	Description
pipeline	MediaPipeline
samplerate	UInt32
stereo	Boolean
config	OdinApmConfig

Variants

ResetEffect()

public void ResetEffect()

ResetEffect(pipeline, samplerate, stereo, config)

public void ResetEffect(MediaPipeline pipeline, uint samplerate, bool stereo, OdinApmConfig config)

Parameters

Name	Type	Description
pipeline	MediaPipeline
samplerate	UInt32
stereo	Boolean
config	OdinApmConfig

`}),e.add({id:2538,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincustomeffectunitycomponentbase/reseteffect/",title:"ResetEffect",section:"ODIN Documentation",description:"",content:`

public virtual void ResetEffect()

Removes an effect from the pipeline and add a new effect with callbacks

Info

This will affect the location of the effect in the pipeline by index

`}),e.add({id:2539,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/reseteffect/",title:"ResetEffect",section:"ODIN Documentation",description:"",content:`

public void ResetEffect()
public void ResetEffect(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

Variants

ResetEffect()

public void ResetEffect()

ResetEffect(pipeline)

public void ResetEffect(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

`}),e.add({id:2540,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/response/",title:"Response",section:"ODIN Documentation",description:" Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md ",content:`

public static class Response

Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Properties

Name	Description
MsgidIndex	uint32 field (msgid)
ErrorIndex	binary
ResultIndex	binary

`}),e.add({id:2541,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/msgpackmessagetype/response/",title:"Response",section:"ODIN Documentation",description:" Format: [type, msgid, error, result] ",content:`

Response = 1

Format: [type, msgid, error, result]

Value Type

Type	Description
MsgPackMessageType

`}),e.add({id:2542,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/response/resultindex/",title:"ResultIndex",section:"ODIN Documentation",description:" binary|null field (result) ",content:`

public const int ResultIndex = 3

binary|null field (result)

Value Type

Type	Description
Int32

`}),e.add({id:2543,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/resume/",title:"resume",section:"ODIN Documentation",description:"Instructs the server to resume the media object, resuming the reception of data. This operation essentially communicates a server-side unmute request from the client, thus indicating a desire to resume packet reception for this media stream.",content:`

public resume(): void

Instructs the server to resume the media object, resuming the reception of data. This operation essentially communicates a server-side unmute request from the client, thus indicating a desire to resume packet reception for this media stream.

Returns

Type	Description
void

`}),e.add({id:2544,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/resume/",title:"resume",section:"ODIN Documentation",description:"Paused the media stream on the server to start receiving data on it.",content:`

resume(): Promise<void>

Paused the media stream on the server to start receiving data on it.

Returns

Type	Description
Promise<void>

`}),e.add({id:2545,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/resumemedia/",title:"ResumeMedia",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> ResumeMedia(MediaDecoder decoder)
public virtual Task<RpcResult> ResumeMedia(ushort mediaId)

Send a "ResumeMedia" to the server to start a stopped decoder for output.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
decoder	MediaDecoder	output media to start
mediaId	UInt16	raw id to start

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

ResumeMedia(decoder)

public virtual Task<RpcResult> ResumeMedia(MediaDecoder decoder)

Send a "ResumeMedia" to the server to start a stopped decoder for output.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
decoder	MediaDecoder	output media to start

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

ResumeMedia(mediaId)

public virtual Task<RpcResult> ResumeMedia(ushort mediaId)

Send a "ResumeMedia" to the server to start a stopped decoder for output.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
mediaId	UInt16	raw id to start

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2546,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/resumeoutputmedia/",title:"ResumeOutputMedia",section:"ODIN Documentation",description:"",content:`

public virtual bool ResumeOutputMedia(OdinMedia media)
public virtual bool ResumeOutputMedia(MediaDecoder decoder)

Start a stopped remote output decoder

Parameters

Name	Type	Description
media	OdinMedia	output wrapper
decoder	MediaDecoder	output

Returns

Type	Description
Boolean	true on start or false

Variants

ResumeOutputMedia(media)

public virtual bool ResumeOutputMedia(OdinMedia media)

Start a stopped remote output decoder

Parameters

Name	Type	Description
media	OdinMedia	output wrapper

Returns

Type	Description
Boolean	true on start or false

ResumeOutputMedia(decoder)

public virtual bool ResumeOutputMedia(MediaDecoder decoder)

Start a stopped remote output decoder

Parameters

Name	Type	Description
decoder	MediaDecoder	output

Returns

Type	Description
Boolean	true on start or false

`}),e.add({id:2547,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/connectionstatechangedeventargs/retry/",title:"Retry",section:"ODIN Documentation",description:" Connection retry count ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public int Retry { get; }

Connection retry count

Value Type

Type	Description
Int32

`}),e.add({id:2548,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/connectionstatechangedeventargs/retry/",title:"Retry",section:"ODIN Documentation",description:" Connection retry count ",content:`

public int Retry { get; }

Connection retry count

Value Type

Type	Description
Int32

`}),e.add({id:2549,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/connectionstatechangedeventargs/retry/",title:"Retry",section:"ODIN Documentation",description:" Connection retry count ",content:`

public int Retry { get; }

Connection retry count

Value Type

Type	Description
Int32

`}),e.add({id:2550,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/connectionstatechangedeventargs/retry/",title:"Retry",section:"ODIN Documentation",description:" Connection retry count ",content:`

public int Retry { get; }

Connection retry count

Value Type

Type	Description
Int32

`}),e.add({id:2551,href:"https://www.4players.io/odin/sdk/unity/classes/connectionstatechangedeventargs/retry/",title:"Retry",section:"ODIN Documentation",description:" Connection retry count ",content:`

public int Retry { get; }

Connection retry count

Value Type

Type	Description
Int32

`}),e.add({id:2552,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaactivestatechangedeventargs/rmsdbfs/",title:"RmsDbfs",section:"ODIN Documentation",description:" value between the peak and minimum for amplitude levels ",content:`

public float RmsDbfs { get; }

value between the peak and minimum for amplitude levels

Value Type

Type	Description
Single

`}),e.add({id:2553,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/rolloffmode/",title:"RolloffMode",section:"ODIN Documentation",description:" Property of AudioSource ",content:`

public AudioRolloffMode RolloffMode { get; set; }

Property of AudioSource

Value Type

Type	Description
AudioRolloffMode

`}),e.add({id:2554,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiostatseventpayload/room/",title:"room",section:"ODIN Documentation",description:"The `OdinRoom` instance the stats ere coming from.",content:`

OdinRoom

The OdinRoom instance the stats ere coming from.

Properties

Name	Type	Description
ConnectionRetry	Int32	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
Config	RoomConfig	Room configuration
IsJoined	Boolean	true on successful Join or false
Self	Peer	Client Peer
RoomUserData	UserData
RemotePeers	PeerCollection	Conatiner of room peers
PlaybackMedias	IEnumerable<MediaCollection>	Get all medias of room peers
MicrophoneMedia	MicrophoneStream	Current room microphone data route

Static Properties

Name	Type	Description
ConnectionState	KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>	ConnectionState of the Room that is set by ODIN

Public Methods

Name	Description
GetRoomId	Retrieves the room ID (e.g. the name of the room)
GetRoomCustomer	Retrieves the identifier of the customer the room
GetRoomPeerId	Retrieves your own peer ID
SetApmConfig	Set rooms new Apm config
Join	Join the room via Odin gateway
CreateMicrophoneMedia	Try to add a MicrophoneMedia
UpdatePeerUserData	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdatePeerUserDataAsync	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdateRoomUserData	Updates the user data for the current room.
UpdateRoomUserDataAsync	Updates the user data for the current room.
SendMessage	Sends arbitrary data to a array of target peerIds.
SendMessageAsync	Sends arbitrary data to a array of target peerIds.
BroadcastMessage	Sends arbitrary data to a all remote peers in this room.
BroadcastMessageAsync	Sends arbitrary data to a all remote peers in this room.
GetRemotePeersIds	Get a copy of all PeerIds in this room
GetRemotePeersMediaStreamIds	All ids of Media from remote peers in this room
SetMicrophoneMute	Will set the room MicrophoneMedia to mute
SetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in the room
UpdatePosition	Updates the two-dimensional position of our own peer in the room
ToString	Debug
Leave	Leave a room and free all remote peers and associated medias
Dispose	On dispose will free the room and token generator

`}),e.add({id:2563,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2564,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2565,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2566,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/",title:"Room",section:"ODIN Documentation",description:" Main Room ",content:`

public class Room : IDisposable

Main Room

Properties

Name	Type	Description
ConnectionRetry	Int32	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
Config	RoomConfig	Room configuration
IsJoined	Boolean	true on successful Join or false
Self	Peer	Client Peer
RoomUserData	UserData	Odin UserData helper for marshal byte arrays on Room level
RemotePeers	PeerCollection	Conatiner of room peers
PlaybackMedias	IEnumerable<MediaCollection>	Get all medias of room peers
MicrophoneMedia	MicrophoneStream	Current room microphone data route

Static Properties

Name	Type	Description
ConnectionState	KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>	ConnectionState of the Room that is set by ODIN

Public Methods

Name	Description
GetRoomId	Retrieves the room ID (e.g. the name of the room)
GetRoomCustomer	Retrieves the identifier of the customer the room
GetRoomPeerId	Retrieves your own peer ID
GetRoomConnectionStats	Retrieves statistics for the underlying connection of this room
SetApmConfig	Set rooms new Apm config
Join	Join the room via Odin gateway
CreateMicrophoneMedia	Try to add a MicrophoneMedia
UpdatePeerUserData	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdatePeerUserDataAsync	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdateRoomUserData	Updates the user data for the current room.
UpdateRoomUserDataAsync	Updates the user data for the current room.
SendMessage	Sends arbitrary data to a array of target peerIds.
SendMessageAsync	Sends arbitrary data to a array of target peerIds.
BroadcastMessage	Sends arbitrary data to a all remote peers in this room.
BroadcastMessageAsync	Sends arbitrary data to a all remote peers in this room.
GetRemotePeersIds	Get a copy of all PeerIds in this room
GetRemotePeersMediaStreamIds	All ids of Media from remote peers in this room
SetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in the room
UpdatePosition	Updates the two-dimensional position of our own peer in the room
AudioProcessReverse	Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.This should only be done if you are NOT using AudioMixStreams(RoomHandle%2cStreamHandle%5b%5d%2cSystem.
ToString	Debug
Leave	Leave a room and free all remote peers and associated medias
Dispose	On dispose will free the room and token generator

`}),e.add({id:2567,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2568,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2569,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2570,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/",title:"Room",section:"ODIN Documentation",description:" Main Room ",content:`

public class Room : IDisposable

Main Room

Properties

Name	Type	Description
ConnectionRetry	Int32	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
Config	RoomConfig	Room configuration
IsJoined	Boolean	true on successful Join or false
Self	Peer	Client Peer
RoomUserData	UserData
RemotePeers	PeerCollection	Conatiner of room peers
PlaybackMedias	IEnumerable<MediaCollection>	Get all medias of room peers
MicrophoneMedia	MicrophoneStream	Current room microphone data route

Static Properties

Name	Type	Description
ConnectionState	KeyValuePair<OdinRoomConnectionState,OdinRoomConnectionStateChangeReason>	ConnectionState of the Room that is set by ODIN

Public Methods

Name	Description
GetRoomId	Retrieves the room ID (e.g. the name of the room)
GetRoomCustomer	Retrieves the identifier of the customer the room
GetRoomPeerId	Retrieves your own peer ID
SetApmConfig	Set rooms new Apm config
Join	Join the room via Odin gateway
CreateMicrophoneMedia	Try to add a MicrophoneMedia
UpdatePeerUserData	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdatePeerUserDataAsync	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdateRoomUserData	Updates the user data for the current room.
UpdateRoomUserDataAsync	Updates the user data for the current room.
SendMessage	Sends arbitrary data to a array of target peerIds.
SendMessageAsync	Sends arbitrary data to a array of target peerIds.
BroadcastMessage	Sends arbitrary data to a all remote peers in this room.
BroadcastMessageAsync	Sends arbitrary data to a all remote peers in this room.
GetRemotePeersIds	Get a copy of all PeerIds in this room
GetRemotePeersMediaStreamIds	All ids of Media from remote peers in this room
SetMicrophoneMute	Will set the room MicrophoneMedia to mute
SetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in the room
UpdatePosition	Updates the two-dimensional position of our own peer in the room
ToString	Debug
Leave	Leave a room and free all remote peers and associated medias
Dispose	On dispose will free the room and token generator

`}),e.add({id:2571,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2572,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2573,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2574,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/",title:"Room",section:"ODIN Documentation",description:" Main Room ",content:`

public class Room : IDisposable

Main Room

Constructors

Name	Description
Room(String, String, String, String, OdinMediaConfig, OdinRoomConfig, Boolean)	Create a ODIN ffi room
Room(RoomConfig)	Create a ODIN ffi room

Events

Name	Description
OnPeerJoined	Passthrough event that identified a new PeerJoined event by Event-Tag.
OnPeerLeft	Passthrough event that identified a new PeerLeft event by Event-Tag.
OnPeerUserDataChanged	Passthrough event that identified a new PeerUpdated event by Event-Tag.
OnMediaAdded	Passthrough event that identified a new MediaAdded event by Event-Tag.
OnMediaRemoved	Passthrough event that identified a new MediaRemoved event by Event-Tag.
OnMediaActiveStateChanged	Passthrough event that identified a new MediaActiveStateChanged event by Event-Tag.
OnRoomUserDataChanged	Passthrough event that identified a new RoomUserDataChanged event by Event-Tag. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.
OnMessageReceived	Passthrough event that identified a new MessageReceived event by Event-Tag.
OnConnectionStateChanged	Passthrough event that identified a new ConnectionStateChanged event by Event-Tag.

Properties

Name	Description
ConnectionRetry	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
Config	Room configuration
IsJoined	true on successful Join or false
Self	Client Peer
RoomUserData	Odin UserData helper for marshal byte arrays on Room level
RemotePeers	Conatiner of room peers
PlaybackMedias	Get all medias of room peers
MicrophoneMedia	Current room microphone data route

Static Properties

Name	Description
ConnectionState	ConnectionState of the Room that is set by ODIN

Public Methods

Name	Description
GetRoomId	Retrieves the room ID (e.g. the name of the room)
GetRoomCustomer	Retrieves the identifier of the customer the room
GetRoomPeerId	Retrieves your own peer ID
GetRoomConnectionStats	Retrieves statistics for the underlying connection of this room
SetApmConfig	Set rooms new Apm config
Join	Join the room via Odin gateway
CreateMicrophoneMedia	Try to add a MicrophoneMedia
UpdatePeerUserData	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdatePeerUserDataAsync	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
SendMessage	Sends arbitrary data to a array of target peerIds.
SendMessageAsync	Sends arbitrary data to a array of target peerIds.
BroadcastMessage	Sends arbitrary data to a all remote peers in this room.
BroadcastMessageAsync	Sends arbitrary data to a all remote peers in this room.
GetRemotePeersIds	Get a copy of all PeerIds in this room
GetRemotePeersMediaStreamIds	All ids of Media from remote peers in this room
SetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in the room
UpdatePosition	Updates the two-dimensional position of our own peer in the room
AudioProcessReverse	Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.This should only be done if you are NOT using AudioMixStreams(RoomHandle%2cStreamHandle%5b%5d%2cSystem.
ToString	Debug
Leave	Leave a room and free all remote peers and associated medias
Dispose	On dispose will free the room and token generator

`}),e.add({id:2575,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2576,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2577,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2578,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/",title:"Room",section:"ODIN Documentation",description:" Main Room ",content:`

OdinConnectionStateChangedEvent

public class Room : IRoom, IDisposable

Main Room

Discussion

The Room class is the entry point of the low-level API of the ODIN SDK. It provides methods to join and leave a room, send and receive messages, and manage media streams. The Room class is also responsible for managing the connection state and the room configuration.

If don’t want to develop everything yourself, it is recommended to use OdinRoom instead which is a higher level API and is easier to use.

The basic flow is to use Room.Create to create a Room object, configure it with event handlers, and then join the room. Once joined, you can attach a media stream to the room and start sending and receiving media (i.e. microphone). You need to listen on the Room.OnMediaStarted event to receive media streams from other peers in the room and to create playback components for them.

See the example below for a basic usage of the Room class.

Constructors

Name	Description
Room(OdinConnectionPoolHandle, String, UInt32, Boolean)	Initialise dangling room

Events

Name	Description
OnDatagram	Call on audio data
OnRpc	Call on rpc data
OnSendRpcResponse	Call on response to a rpc request
OnConnectionStatusChanged
OnRoomJoined
OnPeerJoined
OnPeerLeft
OnMediaStarted
OnMediaStopped
OnUserDataChanged
OnMessageReceived

Static Methods

Name	Description
Create	Initialise independent room
Join	Create and join a Room

Properties

Name	Description
Samplerate	Room default samplerate
Stereo	Room default stereo flag
EndPoint	Room server gateway endpoint
Id	RoomId
OwnPeerId	PeerId of self
Name	Room name
ConnectionStatus	RoomStatus
IsConnected	IsJoined
IsClosed	IsClosed
PositionX	Inital position of self on join
PositionY	Inital position of self on join
PositionZ	Inital position of self on join
RpcWriter	Msgpack writer for RPC
RpcAckActive	Toggle message type for Room.SendRpc true is request and false is notification. Currently calls to "UpdatePeer" and "SetPeerPosition" needs to be requests!
RpcTableThunk	Msgpack results to RPC requests
RoomUserData	Odin UserData helper for marshal byte arrays on Room level
RemotePeers	Conatiner of room peers
Encoders	Container of room input medias
Decoders	Elements of room output medias
Token	Room joining token
Parent	Default value null indicates root or not set
AvailableEncoderIds	Available media ids that are reserved for the room

Public Methods

Name	Description
GetBaseRoom	This will always return itself
Room_OnDatagram	Default impl will push a datagram to all Room of the same mediaId in the current room.
Room_OnRPC	Default impl will process all rpc packets.
ProcessRPC	Will process all rpc packets.
Join	Join a room with token
GetRoomId	Retrieves the room id
GetEncoder	Get a encoder from Room by id
GetOrCreateEncoder	Get a encoder from Room.
CreateEncoder	Create a new input media that will be added toRoom
RemoveEncoder	Removes the input media from Room
GetDecoder	Get a decoder from RemotePeers by id
GetOrCreateDecoder	Get a decoder from RemotePeers by id. If the decoder is not found create a new one that will be added to the Peer
CreateDecoder	Create a new output media that will be added to PeerEntity
RemoveDecoder	Removes a output media from a remote peer.
StartMedia	Send a "StartMedia" RPC to the server to start the encoder for input.
StopMedia	Send a "StopMedia" to the server to stop the encoder.
PauseMedia	Send a "PauseMedia" to the server to stop the decoder for output.
ResumeMedia	Send a "ResumeMedia" to the server to start a stopped decoder for output.
UpdateUserData	Update arbitrary userdata of self (note: Odin)
SetPosition	Set the spatial position for server side culling. Other remote peers outside the boundary will appear as not in the room or leaving the room.
SendMessage	Send "SendMessage" to the server to broadcast the message with default UTF8 encoding.
SendRpc	Send registered RPCs to the server. (set by Room)
SendAudio	Push the samples to all Room for pipeline processing and pop the result as datagrams to the server
SendEncoderAudio	Pop all samples from the input media by id and send them to the server
Close	Close the native room. (native dispose)
Dispose	On dispose will free the room and all associated data

Example

Room Example

using OdinNative.Odin;
using OdinNative.Odin.Media;
using OdinNative.Odin.Peer;
using OdinNative.Odin.Room;
using OdinNative.Unity;
using OdinNative.Unity.Audio;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using UnityEngine;

/// <summary>
/// This sample is to showcase a basic version of the wrapper
/// </summary>
/// <remarks>For a GameObject/Component sample checkout the 2D or 3D versions</remarks>
public class SampleManagerBasic : MonoBehaviour
{
    public Room _Room;
    public string Gateway;
    public string AccessKey;
    public string RoomName;
    public string UserId;

    public MicrophoneReader _AudioInput;
    public static readonly ConcurrentQueue<Action> UnityQueue = new ConcurrentQueue<Action>();

    void Reset()
    {
        Gateway = "https://gateway.odin.4players.de";
        RoomName = "Test";
        UserId = "DummyUsername";
    }

    // Start is called before the first frame update
    void Start()
    {
        // For persistent room with scene switches
        //DontDestroyOnLoad(this.gameObject);

        if (_Room == null)
        {
            _Room = Room.Create(Gateway, 48000, false);

            // Do NOT use in any circumstances Unity functions in base event callbacks use a dispatch instead
            // or use MonoBehaviour versions like OdinRoom that passthrough invokes to UnityEvents
            // but this sample is to showcase a basic version; For a GameObject/Component sample checkout InstanceSample2D
            _Room.OnRoomJoined += Example_OnRoomJoined;
            _Room.OnMediaStarted += Example_OnMediaStarted;
            _Room.OnMediaStopped += Example_OnMediaStopped;
            _Room.OnMessageReceived += Example_OnMessageLog;

            // most likely use some kind of remote token request like UnityWebRequest
            // Create token local for showcase purpose only => ACCESSKEY SHOULD NOT BE CLIENT SIDE!
            DateTime utc = DateTime.UtcNow;
            _Room.Join(ExampleKey(new ExampleTokenBody()
            {
                rid = RoomName,
                uid = UserId,
                nbf = ((DateTimeOffset)utc).ToUnixTimeSeconds(),
                exp = ((DateTimeOffset)utc.AddMinutes(5)).ToUnixTimeSeconds() // 5min valid
            }.ToString(), AccessKey));
        }
    }

    private void Example_OnRoomJoined(object sender, ulong ownPeerId, string name, byte[] roomUserData, ushort[] mediaIds, ReadOnlyCollection<PeerRpc> peers)
    {
        Debug.Log($"Joined room \\"{name}\\" with {peers.Count} peers");

        if (_Room == null)
        {
            Debug.LogError($"Can not create encoder without a room");
            return;
        }

        // each room has a limited number of ids reserved for encoders i.e audio input / capture
        if (_Room.AvailableEncoderIds.TryDequeue(out ushort mediaId))
            CreateCapture(mediaId);
        else
            Debug.LogError($"Can not create encoder without a encoder id that is free to use");

        // add already existing medias
        foreach (var peer in _Room.RemotePeers.Values)
            foreach(var decoder in peer.Medias.Values)
                CreatePlayback(decoder, peer);
    }

    private void Example_OnMediaStarted(object sender, ulong peerId, MediaRpc media)
    {
        Debug.Log($"Peer {peerId} started media {media.Id}");

        if (_Room == null)
        {
            Debug.LogError($"Can not add media effects to pipeline without a room in {nameof(Example_OnMediaStarted)}");
            return;
        }

        // in default setup the room creates decoders intern automatically on the event
        // get the decoder corresponding to a peer
        if (_Room.RemotePeers.TryGetValue(peerId, out PeerEntity peer))
            if (peer.Medias.TryGetValue(media.Id, out MediaDecoder decoder))
                CreatePlayback(decoder, peer);
    }

    private void Example_OnMediaStopped(object sender, ulong peerId, ushort mediaId)
    {
        Debug.Log($"Peer {peerId} removed media {mediaId}");

        DispatchDestroyAudioSource($"OdinDecoder {mediaId}");
    }

    private void Example_OnMessageLog(object sender, ulong peerId, byte[] message)
    {
        Debug.Log($"Room \\"{(sender as Room).Name}\\" got message ({message.Length} bytes) from peer {peerId}: \\"{Encoding.UTF8.GetString(message)}\\"");
    }

    private void ProxyAudio(float[] buffer, int _, bool isSilent)
    {
        if (_Room == null) return;
        // send audio to all encoders in the current room
        // or pop/push audio directly on the encoder/decoder
        foreach (var kvp in _Room.Encoders)
            _Room.SendAudio(buffer, kvp.Value, isSilent);
    }

    public void CreateCapture(ushort mediaId)
    {
        if( _Room == null) return;

        // create a encoder where to send audio data to
        if (_Room.GetOrCreateEncoder(mediaId, out MediaEncoder encoder))
        {
            // created encoders have to be started with a customizable rpc call
            _Room.StartMedia(encoder);
            // set a callback for the MicrophoneReader and add sample effects to the pipeline
            LinkEncoderToMicrophone(encoder);
        }
    }

    private void LinkEncoderToMicrophone(MediaEncoder encoder)
    {
        UnityQueue.Enqueue(() =>
        {
            // this sample does not set PersistentListener direct or by prefab
            if (_AudioInput && _AudioInput.OnAudioData?.GetPersistentEventCount() <= 0 && _Room != null)
                _AudioInput.OnAudioData.AddListener(ProxyAudio);

            MicrophoneReader microphone = GetComponent<MicrophoneReader>();
            if (microphone != null)
            {
                // optionally add effects to the encoder (Input/Capture)

                // add voice activity detection
                OdinVadComponent vadComponent = microphone.gameObject.AddComponent<OdinVadComponent>();
                vadComponent.Media = encoder;
                // add a microphone boost
                OdinVolumeBoostComponent volumeBoostComponent = microphone.gameObject.AddComponent<OdinVolumeBoostComponent>();
                volumeBoostComponent.Media = encoder;
            }
        });
    }

    /// <summary>
    /// Add show how
    /// </summary>
    public void CreatePlayback(MediaDecoder decoder, PeerEntity peer)
    {
        // EXAMPLE optionally add INTERNAL effects to the decoder (Output/Playback)
        MediaPipeline pipeline = decoder.GetPipeline();
        if (pipeline.AddVadEffect(out _))
            Debug.Log($"added {nameof(VadEffect)} to \\"OdinDecoder {decoder.Id}\\" of peer {peer.Id}");

        // Odin uses Unity to play the audio
        DispatchCreateAudioSource(decoder, peer);
    }

    /// <summary>
    /// Add OdinMedia that handles <see cref="AudioSource"/> and copy data from Odin to <see cref="AudioClip"/>
    /// </summary>
    /// <remarks>optionally <see cref="MediaDecoder.Pop"/> samples can be used with <see cref="AudioClip.SetData"/></remarks>
    private void DispatchCreateAudioSource(MediaDecoder decoder, PeerEntity peer)
    {
        UnityQueue.Enqueue(() =>
        {
            GameObject container = new GameObject($"OdinDecoder {decoder.Id}");
            container.transform.parent = transform;
            OdinMedia mediaComponent = container.AddComponent<OdinMedia>();
            mediaComponent.MediaDecoder = decoder; // set the decoder to copy data from
            mediaComponent.Parent = peer; // the use of OdinMedia requires a parent else it is optional
            mediaComponent.enabled = true;

            // optionally add interal effects wrapped with Unity to the decoder (Output/Playback)
            // for audio pipeline manipulation

            // add a playback volume boost
            OdinVolumeBoostComponent volumeBoostComponent = container.AddComponent<OdinVolumeBoostComponent>();
            volumeBoostComponent.Media = mediaComponent;
            // add a playback mute
            OdinMuteAudioComponent muteComponent = container.AddComponent<OdinMuteAudioComponent>();
            muteComponent.Media = mediaComponent;
            // see other Effects or build one
            // with CustomEffect (PipelineEffect)
            // or with Unity helper class OdinCustomEffectUnityComponentBase
        });
    }

    /// <summary>
    /// Disposing objects is necessary to prevent memory leaks
    /// </summary>
    /// <remarks>To cleaup Unity versions of Odin components just destroy on gameObject to automatically dispose them <see cref="OnDestroy"/></remarks>
    private void DispatchDestroyAudioSource(string gameObjectName)
    {
        UnityQueue.Enqueue(() =>
        {
            OdinMedia mediaComponent = this.gameObject
                .GetComponentsInChildren<OdinMedia>()
                .FirstOrDefault(component => component.name == gameObjectName);

            if (mediaComponent != null)
                Destroy(mediaComponent.gameObject);
        });
    }

    private void Update()
    {
        if (UnityQueue.IsEmpty == false)
            while (UnityQueue.TryDequeue(out var action))
                action?.Invoke();
    }

    private void OnDestroy()
    {
        if( _Room != null )
        {
            _Room.Dispose();
            _Room = null;
        }
    }

    #region ExampleToken
    [Serializable]
    class ExampleTokenBody
    {
        public string rid;
        public string uid;
        public long nbf;
        public long exp;

        public override string ToString() => JsonUtility.ToJson(this);
    }

    private string ExampleKey(string body, string accesskey = "")
    {
        Debug.LogAssertion("The access key should never be used client side and is for showcase purpose only!");

        if (string.IsNullOrEmpty(accesskey))
        {
            string currentKey = OdinClient.CreateAccessKey();
            Debug.LogWarning($"Generated example key: \\"{currentKey}\\"");
            return OdinClient.CreateToken(currentKey, body);
        }
        else
        {
            Debug.LogWarning($"Using example key: \\"{accesskey}\\"");
            return OdinClient.CreateToken(accesskey, body);
        }
    }
    #endregion ExampleToken
}

`}),e.add({id:2579,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2580,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2581,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2582,href:"https://www.4players.io/odin/sdk/unity/classes/room/",title:"Room",section:"ODIN Documentation",description:" Main Room ",content:`

public class Room : IDisposable

Main Room

Constructors

Name	Description
Room(String, String, String, String, OdinMediaConfig, OdinRoomConfig, Boolean)	Create a ODIN ffi room
Room(RoomConfig)	Create a ODIN ffi room

Events

Name	Description
OnPeerJoined	Passthrough event that identified a new PeerJoined event by Event-Tag.
OnPeerLeft	Passthrough event that identified a new PeerLeft event by Event-Tag.
OnPeerUserDataChanged	Passthrough event that identified a new PeerUpdated event by Event-Tag.
OnMediaAdded	Passthrough event that identified a new MediaAdded event by Event-Tag.
OnMediaRemoved	Passthrough event that identified a new MediaRemoved event by Event-Tag.
OnMediaActiveStateChanged	Passthrough event that identified a new MediaActiveStateChanged event by Event-Tag.
OnRoomUserDataChanged	Passthrough event that identified a new RoomUserDataChanged event by Event-Tag. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.
OnMessageReceived	Passthrough event that identified a new MessageReceived event by Event-Tag.
OnConnectionStateChanged	Passthrough event that identified a new ConnectionStateChanged event by Event-Tag.

Properties

Name	Description
ConnectionRetry	The count of ConnectionState OdinRoomConnectionState retry for reconnects. Reset on Connected
Config	Room configuration
IsJoined	true on successful Join or false
Self	Client Peer
RoomUserData	Odin UserData helper for marshal byte arrays on Room level
RemotePeers	Conatiner of room peers
PlaybackMedias	Get all medias of room peers
MicrophoneMedia	Current room microphone data route

Static Properties

Name	Description
ConnectionState	ConnectionState of the Room that is set by ODIN

Public Methods

Name	Description
GetRoomId	Retrieves the room ID (e.g. the name of the room)
GetRoomCustomer	Retrieves the identifier of the customer the room
GetRoomPeerId	Retrieves your own peer ID
GetRoomConnectionStats	Retrieves statistics for the underlying connection of this room
SetApmConfig	Set rooms new Apm config
Join	Join the room via Odin gateway
CreateMicrophoneMedia	Try to add a MicrophoneMedia
UpdatePeerUserData	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
UpdatePeerUserDataAsync	Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.
SendMessage	Sends arbitrary data to a array of target peerIds.
SendMessageAsync	Sends arbitrary data to a array of target peerIds.
BroadcastMessage	Sends arbitrary data to a all remote peers in this room.
BroadcastMessageAsync	Sends arbitrary data to a all remote peers in this room.
GetRemotePeersIds	Get a copy of all PeerIds in this room
GetRemotePeersMediaStreamIds	All ids of Media from remote peers in this room
SetPositionScale	Configures the allowed 'view' distance for proximity calculation of peers in the room
UpdatePosition	Updates the two-dimensional position of our own peer in the room
AudioProcessReverse	Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.This should only be done if you are NOT using AudioMixStreams(RoomHandle%2cStreamHandle%5b%5d%2cSystem.
ToString	Debug
Leave	Leave a room and free all remote peers and associated medias
Dispose	On dispose will free the room and token generator

`}),e.add({id:2583,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoinedeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2584,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoineventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2585,href:"https://www.4players.io/odin/sdk/unity/classes/roomleaveeventargs/room/",title:"Room",section:"ODIN Documentation",description:" room object ",content:`

public Room Room

room object

Value Type

Type	Description
Room

`}),e.add({id:2586,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/room_ondatagram/",title:"Room_OnDatagram",section:"ODIN Documentation",description:"",content:`

public virtual void Room_OnDatagram(object sender, DatagramEventArgs e)

Default impl will push a datagram to all Room of the same mediaId in the current room.

Info

The room will drop a datagram if there is no decoder to push

Parameters

Name	Type	Description
sender	Object	Room object
e	DatagramEventArgs	Datagram payload

`}),e.add({id:2587,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/room_onrpc/",title:"Room_OnRPC",section:"ODIN Documentation",description:"",content:`

public virtual void Room_OnRPC(object sender, RpcEventArgs e)

Default impl will process all rpc packets.

Info

Client side processing of MsgPackMessageType is not supported and will always response with "MessagePack requests are not supported!" or drop the request on error

Parameters

Name	Type	Description
sender	Object	Room object
e	RpcEventArgs	RPC payload

`}),e.add({id:2588,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/constructor_0/",title:"Room(OdinConnectionPoolHandle, String, UInt32, Boolean)",section:"ODIN Documentation",description:"",content:`

public Room(OdinConnectionPoolHandle connectionPoolHandle, string endPoint, uint samplerate, bool stereo)

Initialise dangling room

Info

For creating an independent room use UInt32%2cSystem

Parameters

Name	Description
connectionPoolHandle	Rooms connection handle
endPoint	Gateway server
samplerate	sets default samplerate
stereo	sets default stereo flag

`}),e.add({id:2589,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/constructor_1/",title:"Room(RoomConfig)",section:"ODIN Documentation",description:"",content:`

public Room(RoomConfig config)

Create a ODIN ffi room

Parameters

Name	Description
config	to use for this room

`}),e.add({id:2590,href:"https://www.4players.io/odin/sdk/unity/classes/room/constructor_1/",title:"Room(RoomConfig)",section:"ODIN Documentation",description:"",content:`

public Room(RoomConfig config)

Create a ODIN ffi room

Parameters

Name	Description
config	to use for this room

`}),e.add({id:2591,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/constructor_0/",title:"Room(String, String, String, String, OdinMediaConfig, OdinRoomConfig, Boolean)",section:"ODIN Documentation",description:"",content:`

public Room(string server, string accessKey, string token, string name, OdinMediaConfig playbackMediaConfig, OdinRoomConfig apmConfig, bool registerEventCallback)

Create a ODIN ffi room

Parameters

Name	Description
server	Endpoint
accessKey	Access Key
token	Room token
name	Room name
playbackMediaConfig	Config to use for on new medias
apmConfig	Config to use for
registerEventCallback	true for or false for no room events

`}),e.add({id:2592,href:"https://www.4players.io/odin/sdk/unity/classes/room/constructor_0/",title:"Room(String, String, String, String, OdinMediaConfig, OdinRoomConfig, Boolean)",section:"ODIN Documentation",description:"",content:`

public Room(string server, string accessKey, string token, string name, OdinMediaConfig playbackMediaConfig, OdinRoomConfig apmConfig, bool registerEventCallback)

Create a ODIN ffi room

Parameters

Name	Description
server	Endpoint
accessKey	Access Key
token	Room token
name	Room name
playbackMediaConfig	Config to use for on new medias
apmConfig	Config to use for
registerEventCallback	true for or false for no room events

`}),e.add({id:2593,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomCollection : IReadOnlyCollection<Room>, IEqualityComparer<Room>

Intern room dictionary

Properties

Name	Type	Description
Item[String]	Room	Try to get room by name
Count	Int32	Count of rooms in the collection
IsRemoveOnly	Boolean	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room by name/token is in the collection
CopyTo	Copies rooms of the collection to an array
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Leave	Get the room and leave

`}),e.add({id:2594,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

public class RoomCollection : IReadOnlyCollection<Room>, IEnumerable<Room>, IEnumerable, IEqualityComparer<Room>

Intern room dictionary

Properties

Name	Type	Description
Item[String]	Room	Try to get room by name
Count	Int32	Count of rooms in the collection
IsRemoveOnly	Boolean	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room by name/token is in the collection
CopyTo	Copies rooms of the collection to an array
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Leave	Get the room and leave
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2595,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

public class RoomCollection : IReadOnlyCollection<Room>, IEqualityComparer<Room>

Intern room dictionary

Properties

Name	Type	Description
Item[String]	Room	Try to get room by name
Count	Int32	Count of rooms in the collection
IsRemoveOnly	Boolean	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room by name/token is in the collection
CopyTo	Copies rooms of the collection to an array
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Leave	Get the room and leave

`}),e.add({id:2596,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

public class RoomCollection : IReadOnlyCollection<Room>, IEnumerable<Room>, IEnumerable, IEqualityComparer<Room>

Intern room dictionary

Constructors

Name	Description
RoomCollection()	Intern room dictionary

Properties

Name	Description
Item[String]	Try to get room by name
Count	Count of rooms in the collection
IsRemoveOnly	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room by name/token is in the collection
CopyTo	Copies rooms of the collection to an array
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Leave	Get the room and leave
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2597,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

public class RoomCollection : IReadOnlyCollection<Room>, IEqualityComparer<Room>

Intern room dictionary

Constructors

Name	Description
RoomCollection()	Intern room dictionary

Properties

Name	Description
Item[String]	Try to get room by name
Item[UInt64]	Get room by Id
Count	Count of rooms in the collection
IsRemoveOnly	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room is in the collection
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Close	Close a room

`}),e.add({id:2598,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/",title:"RoomCollection",section:"ODIN Documentation",description:" Intern room dictionary ",content:`

public class RoomCollection : IReadOnlyCollection<Room>, IEnumerable<Room>, IEnumerable, IEqualityComparer<Room>

Intern room dictionary

Constructors

Name	Description
RoomCollection()	Intern room dictionary

Properties

Name	Description
Item[String]	Try to get room by name
Count	Count of rooms in the collection
IsRemoveOnly	Indicates whether elements can be removed from the collection

Public Methods

Name	Description
Add	Add a room to the collection
Clear	Free and empty the collection
Contains	Determines whether the room by name/token is in the collection
CopyTo	Copies rooms of the collection to an array
Equals	Compares two rooms by name
GetEnumerator	Get enumerator for iteration
GetHashCode	Default GetHashCode
Remove	Removes the room from this collection
Leave	Get the room and leave
System.Collections.IEnumerable.GetEnumerator

`}),e.add({id:2599,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/constructor_0/",title:"RoomCollection()",section:"ODIN Documentation",description:"",content:`

public RoomCollection()

Intern room dictionary

`}),e.add({id:2600,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomcollection/constructor_0/",title:"RoomCollection()",section:"ODIN Documentation",description:"",content:`

public RoomCollection()

Intern room dictionary

`}),e.add({id:2601,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/constructor_0/",title:"RoomCollection()",section:"ODIN Documentation",description:"",content:`

public RoomCollection()

Intern room dictionary

`}),e.add({id:2602,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/",title:"RoomConfig",section:"ODIN Documentation",description:" A set of values that are used when creating Rooms ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Type	Description
AccessKey	String	Room associated AccessKey
TokenLifetime	UInt64	Room associated Token lifetime
Name	String	Room name
Token	String	Room token
Server	String	Room associated endpoint
HasEventCallbacks	Boolean	true if Room where set and registered in ODIN ffi
ApmConfig	OdinRoomConfig	Configuration for NativeBindings
PlaybackMediaConfig	OdinMediaConfig	Configuration for Media on new medias

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:2603,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/",title:"RoomConfig",section:"ODIN Documentation",description:" A set of values that are used when creating Rooms ",content:`

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Type	Description
AccessKey	String	Room associated AccessKey
TokenLifetime	UInt64	Room associated Token lifetime
Name	String	Room name
Token	String	Room token
Server	String	Room associated endpoint
HasEventCallbacks	Boolean	true if Room where set and registered in ODIN ffi
ApmConfig	OdinRoomConfig	Configuration for NativeBindings
PlaybackMediaConfig	OdinMediaConfig	Configuration for Media on new medias

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:2604,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/",title:"RoomConfig",section:"ODIN Documentation",description:" A set of values that are used when creating Rooms ",content:`

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Type	Description
AccessKey	String	Room associated AccessKey
TokenLifetime	UInt64	Room associated Token lifetime
Name	String	Room name
Token	String	Room token
Server	String	Room associated endpoint
HasEventCallbacks	Boolean	true if Room where set and registered in ODIN ffi
ApmConfig	OdinRoomConfig	Configuration for NativeBindings
PlaybackMediaConfig	OdinMediaConfig	Configuration for Media on new medias

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:2605,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/",title:"RoomConfig",section:"ODIN Documentation",description:" A set of values that are used when creating Rooms ",content:`

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Description
AccessKey	Room associated AccessKey
TokenLifetime	Room associated Token lifetime
Name	Room name
Token	Room token
Server	Room associated endpoint
HasEventCallbacks	true if Room where set and registered in ODIN ffi
ApmConfig	Configuration for NativeBindings
PlaybackMediaConfig	Configuration for Media on new medias

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:2606,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/",title:"RoomConfig",section:"ODIN Documentation",description:" A set of values that are used when creating Rooms ",content:`

public class RoomConfig

A set of values that are used when creating Rooms

Properties

Name	Description
AccessKey	Room associated AccessKey
TokenLifetime	Room associated Token lifetime
Name	Room name
Token	Room token
Server	Room associated endpoint
HasEventCallbacks	true if Room where set and registered in ODIN ffi
ApmConfig	Configuration for NativeBindings
PlaybackMediaConfig	Configuration for Media on new medias

Public Methods

Name	Description
ToString	Debug

`}),e.add({id:2607,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2608,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2609,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2610,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	ConnectionStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:2611,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	ConnectionStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:2612,href:"https://www.4players.io/odin/sdk/unity/delegates/roomconnectionstatechangedeventhandler/",title:"RoomConnectionStateChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomConnectionStateChangedEventHandler(object sender, ConnectionStateChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	ConnectionStateChangedEventArgs	Arguments events in the current room

`}),e.add({id:2613,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/roomid/",title:"roomId",section:"ODIN Documentation",description:"The ID of the room that was joined. It's the same as the room id that was passed to join.",content:`

public roomId: string

The ID of the room that was joined. It’s the same as the room id that was passed to join.

`}),e.add({id:2614,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinlefteventpayload/roomid/",title:"roomId",section:"ODIN Documentation",description:"The ID of the room that was left. It's the same as the room id that was passed to join.",content:`

public roomId: string

The ID of the room that was left. It’s the same as the room id that was passed to join.

`}),e.add({id:2615,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagrameventargs/roomid/",title:"RoomId",section:"ODIN Documentation",description:" room id ",content:`

public ulong RoomId { get; }

room id

Value Type

Type	Description
UInt64

`}),e.add({id:2616,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaaddedeventargs/roomid/",title:"RoomId",section:"ODIN Documentation",description:" room id ",content:`

public ulong RoomId { get; }

room id

Value Type

Type	Description
UInt64

`}),e.add({id:2617,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomlefteventargs/roomid/",title:"RoomId",section:"ODIN Documentation",description:" room id ",content:`

public ulong RoomId

room id

Value Type

Type	Description
UInt64

`}),e.add({id:2618,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpceventargs/roomid/",title:"RoomId",section:"ODIN Documentation",description:" room id ",content:`

public ulong RoomId { get; }

room id

Value Type

Type	Description
UInt64

`}),e.add({id:2619,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2620,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

Inherits from:

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2621,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2622,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

Inherits from:

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Description
Room	room object

`}),e.add({id:2623,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Description
Room	room object

`}),e.add({id:2624,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoinedeventargs/",title:"RoomJoinedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoined events when the room was joined successfully ",content:`

Inherits from:

public class RoomJoinedEventArgs : EventArgs

Arguments for RoomJoined events when the room was joined successfully

Properties

Name	Description
Room	room object

`}),e.add({id:2625,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomJoinedProxy : UnityEvent<RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2626,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinedProxy : UnityEvent<RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2627,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomJoinedProxy : UnityEvent<RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2628,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinedProxy : UnityEvent<RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2629,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomJoinedProxy : UnityEvent<object, RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2630,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoinedproxy/",title:"RoomJoinedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinedProxy : UnityEvent<RoomJoinedEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2631,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2632,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

Inherits from:

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2633,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2634,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

Inherits from:

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Description
Room	room object

`}),e.add({id:2635,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Description
Room	room object

`}),e.add({id:2636,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoineventargs/",title:"RoomJoinEventArgs",section:"ODIN Documentation",description:" Arguments for RoomJoin events right before the room is joined ",content:`

Inherits from:

public class RoomJoinEventArgs : EventArgs

Arguments for RoomJoin events right before the room is joined

Properties

Name	Description
Room	room object

`}),e.add({id:2637,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2638,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2639,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2640,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2641,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2642,href:"https://www.4players.io/odin/sdk/unity/classes/roomjoinproxy/",title:"RoomJoinProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomJoinProxy : UnityEvent<RoomJoinEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2643,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2644,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

Inherits from:

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2645,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Type	Description
Room	Room	room object

`}),e.add({id:2646,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

Inherits from:

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Description
Room	room object

`}),e.add({id:2647,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Description
Room	room object

`}),e.add({id:2648,href:"https://www.4players.io/odin/sdk/unity/classes/roomleaveeventargs/",title:"RoomLeaveEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeave events right before the room handle is destroyed ",content:`

Inherits from:

public class RoomLeaveEventArgs : EventArgs

Arguments for RoomLeave events right before the room handle is destroyed

Properties

Name	Description
Room	room object

`}),e.add({id:2649,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2650,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2651,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2652,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2653,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2654,href:"https://www.4players.io/odin/sdk/unity/classes/roomleaveproxy/",title:"RoomLeaveProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeaveProxy : UnityEvent<RoomLeaveEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2655,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Type	Description
RoomName	String	room name

`}),e.add({id:2656,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

Inherits from:

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Type	Description
RoomName	String	room name

`}),e.add({id:2657,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Type	Description
RoomName	String	room name

`}),e.add({id:2658,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

Inherits from:

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Description
RoomName	room name

`}),e.add({id:2659,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Description
RoomId	room id

`}),e.add({id:2660,href:"https://www.4players.io/odin/sdk/unity/classes/roomlefteventargs/",title:"RoomLeftEventArgs",section:"ODIN Documentation",description:" Arguments for RoomLeft events when the room handle was destroyed ",content:`

Inherits from:

public class RoomLeftEventArgs : EventArgs

Arguments for RoomLeft events when the room handle was destroyed

Properties

Name	Description
RoomName	room name

`}),e.add({id:2661,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2662,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2663,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2664,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2665,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2666,href:"https://www.4players.io/odin/sdk/unity/classes/roomleftproxy/",title:"RoomLeftProxy",section:"ODIN Documentation",description:" This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. ",content:`

[Serializable]
public class RoomLeftProxy : UnityEvent<RoomLeftEventArgs>

This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene.

`}),e.add({id:2667,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

`}),e.add({id:2668,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

`}),e.add({id:2669,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

`}),e.add({id:2670,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaAddedEventArgs	Arguments events in the current room

`}),e.add({id:2671,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaAddedEventArgs	Arguments events in the current room

`}),e.add({id:2672,href:"https://www.4players.io/odin/sdk/unity/delegates/roommediaaddedeventhandler/",title:"RoomMediaAddedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaAddedEventHandler(object sender, MediaAddedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaAddedEventArgs	Arguments events in the current room

`}),e.add({id:2673,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

`}),e.add({id:2674,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

`}),e.add({id:2675,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

`}),e.add({id:2676,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaRemovedEventArgs	Arguments events in the current room

`}),e.add({id:2677,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaRemovedEventArgs	Arguments events in the current room

`}),e.add({id:2678,href:"https://www.4players.io/odin/sdk/unity/delegates/roommediaremovedeventhandler/",title:"RoomMediaRemovedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMediaRemovedEventHandler(object sender, MediaRemovedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MediaRemovedEventArgs	Arguments events in the current room

`}),e.add({id:2679,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

`}),e.add({id:2680,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

`}),e.add({id:2681,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

`}),e.add({id:2682,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MessageReceivedEventArgs	Arguments events in the current room

`}),e.add({id:2683,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MessageReceivedEventArgs	Arguments events in the current room

`}),e.add({id:2684,href:"https://www.4players.io/odin/sdk/unity/delegates/roommessagereceivedeventhandler/",title:"RoomMessageReceivedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomMessageReceivedEventHandler(object sender, MessageReceivedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	MessageReceivedEventArgs	Arguments events in the current room

`}),e.add({id:2685,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Associated room name of this peer ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string RoomName { get; }

Associated room name of this peer

Value Type

Type	Description
String

`}),e.add({id:2686,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string RoomName { get; set; }

Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.

Info

Invalid values will cause errors.

Value Type

Type	Description
String

`}),e.add({id:2687,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomlefteventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string RoomName

room name

Value Type

Type	Description
String

`}),e.add({id:2688,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2689,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Associated room name of this peer ",content:`

public string RoomName { get; }

Associated room name of this peer

Value Type

Type	Description
String

`}),e.add({id:2690,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client. ",content:`

public string RoomName { get; set; }

Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.

Info

Invalid values will cause errors.

Value Type

Type	Description
String

`}),e.add({id:2691,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomlefteventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName

room name

Value Type

Type	Description
String

`}),e.add({id:2692,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2693,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Associated room name of this peer ",content:`

public string RoomName { get; }

Associated room name of this peer

Value Type

Type	Description
String

`}),e.add({id:2694,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client. ",content:`

public string RoomName { get; set; }

Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.

Info

Invalid values will cause errors.

Value Type

Type	Description
String

`}),e.add({id:2695,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomlefteventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName

room name

Value Type

Type	Description
String

`}),e.add({id:2696,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2697,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Associated room name of this peer ",content:`

public string RoomName { get; }

Associated room name of this peer

Value Type

Type	Description
String

`}),e.add({id:2698,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client. ",content:`

public string RoomName { get; set; }

Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.

Info

Invalid values will cause errors.

Value Type

Type	Description
String

`}),e.add({id:2699,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomlefteventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName

room name

Value Type

Type	Description
String

`}),e.add({id:2700,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2701,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2702,href:"https://www.4players.io/odin/sdk/unity/classes/peer/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Associated room name of this peer ",content:`

public string RoomName { get; }

Associated room name of this peer

Value Type

Type	Description
String

`}),e.add({id:2703,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/roomname/",title:"RoomName",section:"ODIN Documentation",description:" Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client. ",content:`

public string RoomName { get; set; }

Room name for this playback. Change this value to change the PlaybackStream by Rooms from the Client.

Info

Invalid values will cause errors.

Value Type

Type	Description
String

`}),e.add({id:2704,href:"https://www.4players.io/odin/sdk/unity/classes/roomlefteventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName

room name

Value Type

Type	Description
String

`}),e.add({id:2705,href:"https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedeventargs/roomname/",title:"RoomName",section:"ODIN Documentation",description:" room name ",content:`

public string RoomName { get; }

room name

Value Type

Type	Description
String

`}),e.add({id:2706,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

`}),e.add({id:2707,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

`}),e.add({id:2708,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

`}),e.add({id:2709,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerJoinedEventArgs	Arguments events in the current room

`}),e.add({id:2710,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerJoinedEventArgs	Arguments events in the current room

`}),e.add({id:2711,href:"https://www.4players.io/odin/sdk/unity/delegates/roompeerjoinedeventhandler/",title:"RoomPeerJoinedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerJoinedEventHandler(object sender, PeerJoinedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerJoinedEventArgs	Arguments events in the current room

`}),e.add({id:2712,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

`}),e.add({id:2713,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

`}),e.add({id:2714,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

`}),e.add({id:2715,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerLeftEventArgs	Arguments events in the current room

`}),e.add({id:2716,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerLeftEventArgs	Arguments events in the current room

`}),e.add({id:2717,href:"https://www.4players.io/odin/sdk/unity/delegates/roompeerlefteventhandler/",title:"RoomPeerLeftEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerLeftEventHandler(object sender, PeerLeftEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerLeftEventArgs	Arguments events in the current room

`}),e.add({id:2718,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2719,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2720,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2721,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2722,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2723,href:"https://www.4players.io/odin/sdk/unity/delegates/roompeeruserdatachangedeventhandler/",title:"RoomPeerUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomPeerUserDataChangedEventHandler(object sender, PeerUserDataChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	PeerUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2724,href:"https://www.4players.io/odin/sdk/web/classes/odinclient/rooms/",title:"rooms",section:"ODIN Documentation",description:"An array of available `OdinRoom` instances.",content:`

OdinRoom[]

An array of available OdinRoom instances.

Value Type

Type	Description
RoomCollection

`}),e.add({id:2726,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/rooms/",title:"Rooms",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public RoomCollection Rooms { get; }

Value Type

Type	Description
RoomCollection

`}),e.add({id:2727,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/rooms/",title:"Rooms",section:"ODIN Documentation",description:" A collection of all ",content:`

public RoomCollection Rooms { get; }

A collection of all Room

Value Type

Type	Description
RoomCollection

`}),e.add({id:2728,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/rooms/",title:"Rooms",section:"ODIN Documentation",description:"",content:`

public RoomCollection Rooms { get; }

Value Type

Type	Description
RoomCollection

`}),e.add({id:2729,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/rooms/",title:"Rooms",section:"ODIN Documentation",description:" A collection of all ",content:`

public RoomCollection Rooms { get; }

A collection of all Room

Value Type

Type	Description
RoomCollection

`}),e.add({id:2730,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/rooms/",title:"Rooms",section:"ODIN Documentation",description:"",content:`

public RoomCollection Rooms { get; }

Value Type

Type	Description
RoomCollection

`}),e.add({id:2731,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/rooms/",title:"Rooms",section:"ODIN Documentation",description:" A collection of all ",content:`

public RoomCollection Rooms { get; }

A collection of all Room

Value Type

Type	Description
RoomCollection

`}),e.add({id:2732,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/rooms/",title:"Rooms",section:"ODIN Documentation",description:"",content:`

public RoomCollection Rooms { get; }

Value Type

Type	Description
RoomCollection

`}),e.add({id:2733,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/rooms/",title:"Rooms",section:"ODIN Documentation",description:" A collection of all ",content:`

public RoomCollection Rooms { get; }

A collection of all Room

Value Type

Type	Description
RoomCollection

`}),e.add({id:2734,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/rooms/",title:"Rooms",section:"ODIN Documentation",description:" A collection of all ",content:`

public RoomCollection Rooms { get; }

A collection of all Room

Value Type

Type	Description
RoomCollection

`}),e.add({id:2735,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/rooms/",title:"Rooms",section:"ODIN Documentation",description:"",content:`

public RoomCollection Rooms { get; }

Value Type

Type	Description
RoomCollection

`}),e.add({id:2736,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/roomssetpositionscale/",title:"RoomsSetPositionScale",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void RoomsSetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in each room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2737,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/roomssetpositionscale/",title:"RoomsSetPositionScale",section:"ODIN Documentation",description:"",content:`

public void RoomsSetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in each room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2738,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/roomssetpositionscale/",title:"RoomsSetPositionScale",section:"ODIN Documentation",description:"",content:`

public void RoomsSetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in each room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2739,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/roomssetpositionscale/",title:"RoomsSetPositionScale",section:"ODIN Documentation",description:"",content:`

public void RoomsSetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in each room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2740,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/roomssetpositionscale/",title:"RoomsSetPositionScale",section:"ODIN Documentation",description:"",content:`

public void RoomsSetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in each room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2741,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/roomsupdateposition/",title:"RoomsUpdatePosition",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void RoomsUpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in each room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:2742,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/roomsupdateposition/",title:"RoomsUpdatePosition",section:"ODIN Documentation",description:"",content:`

public void RoomsUpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in each room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:2743,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/roomsupdateposition/",title:"RoomsUpdatePosition",section:"ODIN Documentation",description:"",content:`

public void RoomsUpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in each room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:2744,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/roomsupdateposition/",title:"RoomsUpdatePosition",section:"ODIN Documentation",description:"",content:`

public void RoomsUpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in each room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:2745,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/roomsupdateposition/",title:"RoomsUpdatePosition",section:"ODIN Documentation",description:"",content:`

public void RoomsUpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in each room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:2746,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool RoomUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2747,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool RoomUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2748,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool RoomUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2749,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool RoomUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2750,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool RoomUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2751,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool RoomUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2752,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool RoomUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2753,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool RoomUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2754,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:" Idicates whether the event is enabled by default ",content:`

public static bool RoomUpdatedEvent

Idicates whether the event is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:2755,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/roomupdatedevent/",title:"RoomUpdatedEvent",section:"ODIN Documentation",description:"",content:`

public bool RoomUpdatedEvent

Value Type

Type	Description
Boolean

`}),e.add({id:2756,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/roomuserdata/",title:"roomUserData",section:"ODIN Documentation",description:"The current user data of the room",content:`

public roomUserData: undefined | Uint8Array

The current user data of the room

`}),e.add({id:2757,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UserData RoomUserData { get; }

Value Type

Type	Description
UserData

`}),e.add({id:2758,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays on Room level ",content:`

public UserData RoomUserData { get; }

Odin UserData helper for marshal byte arrays on Room level

Value Type

Type	Description
UserData

`}),e.add({id:2759,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:"",content:`

public UserData RoomUserData { get; }

Value Type

Type	Description
UserData

`}),e.add({id:2760,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays on Room level ",content:`

public UserData RoomUserData { get; }

Odin UserData helper for marshal byte arrays on Room level

Value Type

Type	Description
UserData

`}),e.add({id:2761,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays on Room level ",content:`

public IUserData RoomUserData { get; }

Odin UserData helper for marshal byte arrays on Room level

Value Type

Type	Description
IUserData

`}),e.add({id:2762,href:"https://www.4players.io/odin/sdk/unity/classes/room/roomuserdata/",title:"RoomUserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays on Room level ",content:`

public UserData RoomUserData { get; }

Odin UserData helper for marshal byte arrays on Room level

Value Type

Type	Description
UserData

`}),e.add({id:2763,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinevents/roomuserdatachanged/",title:"RoomUserDataChanged",section:"ODIN Documentation",description:"Fired when the user data of the room changed.",content:`

public RoomUserDataChanged: OdinRoomUserDataChangedEvent

Fired when the user data of the room changed.

Properties

Name	Type	Description
RoomName	String	room name
Data	UserData	room userdata

`}),e.add({id:2765,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomuserdatachangedeventargs/",title:"RoomUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomUserDataChanged events in the current room ",content:`

Inherits from:

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Type	Description
RoomName	String	room name
Data	UserData	room userdata

`}),e.add({id:2766,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomuserdatachangedeventargs/",title:"RoomUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomUserDataChanged events in the current room ",content:`

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Type	Description
RoomName	String	room name
Data	UserData	room userdata

`}),e.add({id:2767,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomuserdatachangedeventargs/",title:"RoomUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomUserDataChanged events in the current room ",content:`

Inherits from:

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Description
RoomName	room name
Data	room userdata

`}),e.add({id:2768,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomuserdatachangedeventargs/",title:"RoomUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomUserDataChanged events in the current room ",content:`

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Description
RoomName	room name
Data	room userdata

`}),e.add({id:2769,href:"https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedeventargs/",title:"RoomUserDataChangedEventArgs",section:"ODIN Documentation",description:" Arguments for RoomUserDataChanged events in the current room ",content:`

Inherits from:

public class RoomUserDataChangedEventArgs : EventArgs

Arguments for RoomUserDataChanged events in the current room

Properties

Name	Description
RoomName	room name
Data	room userdata

`}),e.add({id:2770,href:"https://www.4players.io/odin/sdk/unity/1.1.0/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2771,href:"https://www.4players.io/odin/sdk/unity/1.5.8/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2772,href:"https://www.4players.io/odin/sdk/unity/1.6.0/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room

`}),e.add({id:2773,href:"https://www.4players.io/odin/sdk/unity/1.6.6/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK. ",content:`

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.

Parameters

Name	Type	Description
sender	Object	sender of type
e	RoomUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2774,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	RoomUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2775,href:"https://www.4players.io/odin/sdk/unity/delegates/roomuserdatachangedeventhandler/",title:"RoomUserDataChangedEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK. ",content:`

public delegate void RoomUserDataChangedEventHandler(object sender, RoomUserDataChangedEventArgs e);

EventHandler in the current room. Changing a Room's UserData is only possible via request to Odin server API, but not supported inside the client SDK.

Parameters

Name	Type	Description
sender	Object	sender of type
e	RoomUserDataChangedEventArgs	Arguments events in the current room

`}),e.add({id:2776,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2777,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2778,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2779,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2780,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2781,href:"https://www.4players.io/odin/sdk/unity/classes/roomuserdatachangedproxy/",title:"RoomUserDataChangedProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class RoomUserDataChangedProxy : UnityEvent<object, RoomUserDataChangedEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2782,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpceventargs/rpc/",title:"Rpc",section:"ODIN Documentation",description:" raw Msgpack rpc data ",content:`

public byte[] Rpc { get; }

raw Msgpack rpc data

Value Type

Type	Description
Byte[]

`}),e.add({id:2783,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/rpcackactive/",title:"RpcAckActive",section:"ODIN Documentation",description:" Toggle message type for Room.SendRpc true is request and false is notification. Currently calls to "UpdatePeer" and "SetPeerPosition" needs to be requests! ",content:`

public bool RpcAckActive { get; set; }

Toggle message type for Room.SendRpc true is request and false is notification. Currently calls to "UpdatePeer" and "SetPeerPosition" needs to be requests!

Value Type

Type	Description
Boolean

`}),e.add({id:2784,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpceventargs/",title:"RpcEventArgs",section:"ODIN Documentation",description:" Arguments for rpc events ",content:`

public class RpcEventArgs : EventArgs

Arguments for rpc events

Properties

Name	Description
RoomId	room id
Rpc	raw Msgpack rpc data
Userdata	unused

`}),e.add({id:2785,href:"https://www.4players.io/odin/sdk/unity/2.0.0/delegates/rpceventhandler/",title:"RpcEventHandler",section:"ODIN Documentation",description:" EventHandler in the current room ",content:`

public delegate void RpcEventHandler(object sender, RpcEventArgs e);

EventHandler in the current room

Parameters

Name	Type	Description
sender	Object	sender of type
e	RpcEventArgs	Arguments events

`}),e.add({id:2786,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcformat/",title:"RpcFormat",section:"ODIN Documentation",description:" Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md ",content:`

public static class RpcFormat

Msgpack RPC spec https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md

Properties

Name	Description
TypeIndex	PositiveFixInt field (type)

`}),e.add({id:2787,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcproxy/",title:"RpcProxy",section:"ODIN Documentation",description:" This class provides the base functionality for UnityEvents based . A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) ",content:`

public class RpcProxy : UnityEvent<object, RpcEventArgs>

This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:2788,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcresult/",title:"RpcResult",section:"ODIN Documentation",description:" Result of send rpc responses msgid, (method, params, error, result) ",content:`

public class RpcResult : EventArgs

Result of send rpc responses

msgid, (method, params, error, result)

Properties

Name	Description
Id	msgid
Name	method
Error	error
Value	result

`}),e.add({id:2789,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/rpctablethunk/",title:"RpcTableThunk",section:"ODIN Documentation",description:" Msgpack results to RPC requests ",content:`

public ConcurrentDictionary<uint, TaskCompletionSource<RpcResult>> RpcTableThunk { get; }

Msgpack results to RPC requests

Value Type

Type	Description
ConcurrentDictionary<UInt32,TaskCompletionSource<RpcResult>>

`}),e.add({id:2790,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/rpcwriter/",title:"RpcWriter",section:"ODIN Documentation",description:" Msgpack writer for RPC ",content:`

public IMsgPackWriter RpcWriter { get; set; }

Msgpack writer for RPC

Value Type

Type	Description
IMsgPackWriter

`}),e.add({id:2791,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/rtt/",title:"rtt",section:"ODIN Documentation",description:" Current best estimate of the connection latency (round-trip-time) in milliseconds ",content:`

public float rtt

Current best estimate of the connection latency (round-trip-time) in milliseconds

Value Type

Type	Description
Single

`}),e.add({id:2792,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/rtt/",title:"rtt",section:"ODIN Documentation",description:" Current best estimate of the connection latency (round-trip-time) in milliseconds ",content:`

public float rtt

Current best estimate of the connection latency (round-trip-time) in milliseconds

Value Type

Type	Description
Single

`}),e.add({id:2793,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/rtt/",title:"rtt",section:"ODIN Documentation",description:" Current best estimate of the connection latency (round-trip-time) in milliseconds ",content:`

public float rtt

Current best estimate of the connection latency (round-trip-time) in milliseconds

Value Type

Type	Description
Single

`}),e.add({id:2794,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/rtt_milliseconds/",title:"rtt_milliseconds",section:"ODIN Documentation",description:"",content:`

public UInt32 rtt_milliseconds

Value Type

Type	Description
UInt32

`}),e.add({id:2795,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:" Output decoder samplerate ",content:`

public uint Samplerate { get; }

Output decoder samplerate

Value Type

Type	Description
UInt32

`}),e.add({id:2796,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:" Output samplerate ",content:`

public uint Samplerate { get; }

Output samplerate

Value Type

Type	Description
UInt32

`}),e.add({id:2797,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:" Input samplerate ",content:`

public uint Samplerate { get; }

Input samplerate

Value Type

Type	Description
UInt32

`}),e.add({id:2798,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:"",content:`

public int Samplerate

Value Type

Type	Description
Int32

`}),e.add({id:2799,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:" Unity samplerate ",content:`

public uint Samplerate { get; set; }

Unity samplerate

Value Type

Type	Description
UInt32

`}),e.add({id:2800,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/samplerate/",title:"Samplerate",section:"ODIN Documentation",description:" Room default samplerate ",content:`

public readonly uint Samplerate

Room default samplerate

Value Type

Type	Description
UInt32

`}),e.add({id:2801,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The recording ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaSampleRate SampleRate

The recording Core

Info

Set value by DeviceSampleRate on false. For (Microphone.Start) creation of (AudioClip) if OverrideSampleRate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2802,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinmediaconfig/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The number audio samples carried per second in Hz ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaSampleRate SampleRate { get; set; }

The number audio samples carried per second in Hz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2803,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/playbackcomponent/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The playback ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public MediaSampleRate SampleRate

The playback Core

Info

Set value is ignored on (AudioClip) creation if OverrideSampleRate is false

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2804,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The recording ",content:`

public MediaSampleRate SampleRate

The recording Core

Info

Set value by DeviceSampleRate on false. For (Microphone.Start) creation of (AudioClip) if OverrideSampleRate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2805,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinmediaconfig/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The number audio samples carried per second in Hz ",content:`

public MediaSampleRate SampleRate { get; set; }

The number audio samples carried per second in Hz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2806,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/playbackcomponent/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The playback ",content:`

public MediaSampleRate SampleRate

The playback Core

Info

Set value is ignored on (AudioClip) creation if OverrideSampleRate is false

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2807,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The recording ",content:`

public MediaSampleRate SampleRate

The recording Core

Info

Set value by DeviceSampleRate on false. For (Microphone.Start) creation of (AudioClip) if OverrideSampleRate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2808,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinmediaconfig/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The number audio samples carried per second in Hz ",content:`

public MediaSampleRate SampleRate { get; set; }

The number audio samples carried per second in Hz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2809,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/playbackcomponent/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The playback ",content:`

public MediaSampleRate SampleRate

The playback Core

Info

Set value is ignored on (AudioClip) creation if OverrideSampleRate is false

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2810,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The recording ",content:`

public MediaSampleRate SampleRate

The recording Core

Info

Set value by OdinEditorConfig on false. For (Microphone.Start) creation of (AudioClip) if MicrophoneReader

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2811,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinmediaconfig/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The number audio samples carried per second in Hz ",content:`

public MediaSampleRate SampleRate { get; set; }

The number audio samples carried per second in Hz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2812,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The playback ",content:`

public MediaSampleRate SampleRate

The playback Core

Info

Set value is ignored on (AudioClip) creation if OverrideSampleRate is false

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2813,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The recording ",content:`

public MediaSampleRate SampleRate

The recording Core

Info

Set value by DeviceSampleRate on false. For (Microphone.Start) creation of (AudioClip) if OverrideSampleRate

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2814,href:"https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The number audio samples carried per second in Hz ",content:`

public MediaSampleRate SampleRate { get; set; }

The number audio samples carried per second in Hz

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2815,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/samplerate/",title:"SampleRate",section:"ODIN Documentation",description:" The playback ",content:`

public MediaSampleRate SampleRate

The playback Core

Info

Set value is ignored on (AudioClip) creation if OverrideSampleRate is false

Value Type

Type	Description
MediaSampleRate

`}),e.add({id:2816,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/samples/",title:"samples",section:"ODIN Documentation",description:" float[] ",content:`

public IntPtr samples

float[]

Value Type

Type	Description
IntPtr

`}),e.add({id:2817,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/samples/",title:"samples",section:"ODIN Documentation",description:"",content:`

public readonly IntPtr samples

Value Type

Type	Description
IntPtr

`}),e.add({id:2818,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinaudioreadonlydata/samples/",title:"samples",section:"ODIN Documentation",description:" float[] ",content:`

public IntPtr samples

float[]

Value Type

Type	Description
IntPtr

`}),e.add({id:2819,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/samples_count/",title:"samples_count",section:"ODIN Documentation",description:"",content:`

public UInt32 samples_count

Value Type

Type	Description
UInt32

`}),e.add({id:2820,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincallbackaudiodata/samples_count/",title:"samples_count",section:"ODIN Documentation",description:"",content:`

public readonly UInt32 samples_count

Value Type

Type	Description
UInt32

`}),e.add({id:2821,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinaudioreadonlydata/samples_count/",title:"samples_count",section:"ODIN Documentation",description:"",content:`

public UInt32 samples_count

Value Type

Type	Description
UInt32

`}),e.add({id:2822,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinaudiodatareceivedeventpayload/samples16/",title:"samples16",section:"ODIN Documentation",description:"The audio data received from the peer as 16-bit PCM samples ranging from -32768 to 32767 as a byte array. Use `const samplesArray = new Int16Array(samples16.buffer)` to get an actual array",content:`

public samples16: Uint8Array

The audio data received from the peer as 16-bit PCM samples ranging from -32768 to 32767 as a byte array. Use const samplesArray = new Int16Array(samples16.buffer) to get an actual array

`}),e.add({id:2823,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinaudiodatareceivedeventpayload/samples32/",title:"samples32",section:"ODIN Documentation",description:"The audio data received from the peer as 32-bit PCM samples ranging from -1 to 1. Use `const floats = new Float32Array(samples32.buffer)` to get an actual array",content:`

public samples32: Uint8Array

The audio data received from the peer as 32-bit PCM samples ranging from -1 to 1. Use const floats = new Float32Array(samples32.buffer) to get an actual array

`}),e.add({id:2824,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/samplescount/",title:"SamplesCount",section:"ODIN Documentation",description:"",content:`

public uint SamplesCount { get; }

Value Type

Type	Description
UInt32

`}),e.add({id:2825,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumeboostcomponent/scale/",title:"Scale",section:"ODIN Documentation",description:"",content:`

public float Scale

Value Type

Type	Description
Single

`}),e.add({id:2826,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/self/",title:"Self",section:"ODIN Documentation",description:" Client Peer ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public Peer Self { get; }

Client Peer

Value Type

Type	Description
Peer

`}),e.add({id:2827,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/self/",title:"Self",section:"ODIN Documentation",description:" Client Peer ",content:`

public Peer Self { get; }

Client Peer

Value Type

Type	Description
Peer

`}),e.add({id:2828,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/self/",title:"Self",section:"ODIN Documentation",description:" Client Peer ",content:`

public Peer Self { get; }

Client Peer

Value Type

Type	Description
Peer

`}),e.add({id:2829,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/self/",title:"Self",section:"ODIN Documentation",description:" Client Peer ",content:`

public Peer Self { get; }

Client Peer

Value Type

Type	Description
Peer

`}),e.add({id:2830,href:"https://www.4players.io/odin/sdk/unity/classes/room/self/",title:"Self",section:"ODIN Documentation",description:" Client Peer ",content:`

public Peer Self { get; }

Client Peer

Value Type

Type	Description
Peer

`}),e.add({id:2831,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/sendaudio/",title:"SendAudio",section:"ODIN Documentation",description:"",content:`

public virtual void SendAudio(float[] samples, bool isSilent = false)
public virtual bool SendAudio(float[] samples, ushort mediaId, bool isSilent = false)
public virtual bool SendAudio(float[] samples, MediaEncoder encoder, bool isSilent = false)

Push the samples to all Room for pipeline processing and pop the result as datagrams to the server

Parameters

Name	Type	Description
samples	Single[]	Audio data
isSilent	Boolean	flag these samples as silence
mediaId	UInt16	input media id
encoder	MediaEncoder	input media

Returns

Type	Description
Boolean	true on success or false

Variants

SendAudio(samples, isSilent)

public virtual void SendAudio(float[] samples, bool isSilent = false)

Push the samples to all Room for pipeline processing and pop the result as datagrams to the server

Parameters

Name	Type	Description
samples	Single[]	Audio data
isSilent	Boolean	flag these samples as silence

SendAudio(samples, mediaId, isSilent)

public virtual bool SendAudio(float[] samples, ushort mediaId, bool isSilent = false)

Push the samples to the input media for pipeline processing and pop the result as datagram to the server

Parameters

Name	Type	Description
samples	Single[]	Audio data
mediaId	UInt16	input media id
isSilent	Boolean	flag these samples as silence

Returns

Type	Description
Boolean	true on success or false

SendAudio(samples, encoder, isSilent)

public virtual bool SendAudio(float[] samples, MediaEncoder encoder, bool isSilent = false)

Push the samples to the input media for pipeline processing and pop the result as datagram to the server

Parameters

Name	Type	Description
samples	Single[]	Audio data
encoder	MediaEncoder	input media
isSilent	Boolean	flag these samples as silence

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2832,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinmedia/sendaudiodata/",title:"sendAudioData",section:"ODIN Documentation",description:"Sends audio data to the room. The data must be in the format specified when creating the media as a 32-bit float array. Samples need to be between -1 and 1. Audio data needs to be sent in regular intervals, otherwise the audio will be sound interrupted. See the example for more details.",content:`

public sendAudioData(data: Float32Array): void

Sends audio data to the room. The data must be in the format specified when creating the media as a 32-bit float array. Samples need to be between -1 and 1. Audio data needs to be sent in regular intervals, otherwise the audio will be sound interrupted. See the example for more details.

Parameters

Name	Type	Description
data	Float32Array	A 32-bit float array containing the audio data.

Returns

Type	Description
void

`}),e.add({id:2833,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/sendencoderaudio/",title:"SendEncoderAudio",section:"ODIN Documentation",description:"",content:`

public virtual bool SendEncoderAudio(ushort mediaId)
public virtual bool SendEncoderAudio(MediaEncoder encoder)

Pop all samples from the input media by id and send them to the server

Parameters

Name	Type	Description
mediaId	UInt16	input media id
encoder	MediaEncoder	input media

Returns

Type	Description
Boolean	true on success or false

Variants

SendEncoderAudio(mediaId)

public virtual bool SendEncoderAudio(ushort mediaId)

Pop all samples from the input media by id and send them to the server

Parameters

Name	Type	Description
mediaId	UInt16	input media id

Returns

Type	Description
Boolean	true on success or false

SendEncoderAudio(encoder)

public virtual bool SendEncoderAudio(MediaEncoder encoder)

Pop all samples from the input media and send them to the server

Parameters

Name	Type	Description
encoder	MediaEncoder	input media

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:2834,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinmessagereceivedeventpayload/senderid/",title:"senderId",section:"ODIN Documentation",description:"The ID of the peer that sent the message (might not be in proximity).",content:`

number

The ID of the peer that sent the message (might not be in proximity).

`}),e.add({id:2835,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/sendmessage/",title:"sendMessage",section:"ODIN Documentation",description:"Sends a message to the room.",content:`

public sendMessage(message: Uint8Array, peerIdList?: number[]): void

Sends a message to the room.

Parameters

Name	Type	Description
message	Uint8Array	The message to send as a byte array.
peerIdList	number[]	The list of peer IDs to send the message to. If this is undefined, the message will be sent to all peers. If the list is defined and empty an error will be thrown.

Returns

Type	Description
void

`}),e.add({id:2836,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/sendmessage/",title:"sendMessage",section:"ODIN Documentation",description:"Sends a message with arbitrary data to this peer.",content:`

sendMessage(message: Uint8Array): Promise<void>

Sends a message with arbitrary data to this peer.

Parameters

Name	Type	Description
message	Uint8Array	Byte array of arbitrary data to send

Returns

Type	Description
Promise<void>

`}),e.add({id:2837,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/sendmessage/",title:"sendMessage",section:"ODIN Documentation",description:"Sends a message with arbitrary data to all peers in the room or optionally to a list of specified peers.",content:`

sendMessage(message: Uint8Array, targetPeerIds?: number[]): Promise<void>

Sends a message with arbitrary data to all peers in the room or optionally to a list of specified peers.

Parameters

Name	Type	Description
message	Uint8Array	Byte array of arbitrary data to send
targetPeerIds	number[]	Optional list of target peer IDs

Returns

Type	Description
Promise<void>

`}),e.add({id:2838,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool SendMessage(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:2839,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

public bool SendMessage(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:2840,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

public bool SendMessage(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:2841,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

public bool SendMessage(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:2842,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> SendMessage(string message)
public virtual Task<RpcResult> SendMessage(string message, Encoding encoding)
public virtual Task<RpcResult> SendMessage(byte[] message)

Send "SendMessage" to the server to broadcast the message with default UTF8 encoding.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
message	String	UTF8 string
encoding	Encoding	custom encoding
message	Byte[]	arbitrary data

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

SendMessage(message)

public virtual Task<RpcResult> SendMessage(string message)

Send "SendMessage" to the server to broadcast the message with default UTF8 encoding.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
message	String	UTF8 string

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

SendMessage(message, encoding)

public virtual Task<RpcResult> SendMessage(string message, Encoding encoding)

Send "SendMessage" to the server to broadcast the message.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
message	String	string
encoding	Encoding	custom encoding

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

SendMessage(message)

public virtual Task<RpcResult> SendMessage(byte[] message)

Send "SendMessage" to the server to broadcast an arbitrary message.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
message	Byte[]	arbitrary data

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2843,href:"https://www.4players.io/odin/sdk/unity/classes/room/sendmessage/",title:"SendMessage",section:"ODIN Documentation",description:"",content:`

public bool SendMessage(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Boolean	true if data was send or false

`}),e.add({id:2844,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/sendmessageasync/",title:"SendMessageAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:2845,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/sendmessageasync/",title:"SendMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:2846,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/sendmessageasync/",title:"SendMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:2847,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/sendmessageasync/",title:"SendMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:2848,href:"https://www.4players.io/odin/sdk/unity/classes/room/sendmessageasync/",title:"SendMessageAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> SendMessageAsync(ulong[] peerIdList, byte[] data)

Sends arbitrary data to a array of target peerIds.

Info

associated ids of peers must be in the same room and should not be empty

Parameters

Name	Type	Description
peerIdList	UInt64[]	array of ids()
data	Byte[]	arbitrary byte array

Returns

Type	Description
Task<Boolean>	true if data was send or false

`}),e.add({id:2849,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/sendrpc/",title:"SendRpc",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> SendRpc(string method, Action<IMsgPackWriter> builder)

Send registered RPCs to the server. (set by Room)

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
method	String	RPC method
builder	Action<IMsgPackWriter>	Msgpack builder

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2850,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/sequence_number/",title:"sequence_number",section:"ODIN Documentation",description:"",content:`

public Int32 sequence_number

Value Type

Type	Description
Int32

`}),e.add({id:2851,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/sequence_number/",title:"sequence_number",section:"ODIN Documentation",description:"",content:`

public Int32 sequence_number

Value Type

Type	Description
Int32

`}),e.add({id:2852,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/serialize/",title:"Serialize",section:"ODIN Documentation",description:"",content:`

public static byte[] Serialize(T value)
public static IntPtr Serialize(T value, bool destroy = true)

Serialize structure to pointer for arbitary data T

Info

copy data for Marshal.StructureToPtr

Parameters

Name	Type	Description
value	<T>	data structure
destroy	Boolean	free value

Returns

Type	Description
Byte[]	byte array representation of data structure
IntPtr	pointer of data structure

Variants

Serialize(value)

public static byte[] Serialize(T value)

Serialize structure to pointer for arbitary data T

Warning

copy data for Marshal.StructureToPtr

Parameters

Name	Type	Description
value	<T>	data structure

Returns

Type	Description
Byte[]	byte array representation of data structure

Serialize(value, destroy)

public static IntPtr Serialize(T value, bool destroy = true)

Serialize structure to pointer for arbitary data T

Parameters

Name	Type	Description
value	<T>	data structure
destroy	Boolean	free value

Returns

Type	Description
IntPtr	pointer of data structure

`}),e.add({id:2853,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/customeffect/serializeuserdata/",title:"SerializeUserdata",section:"ODIN Documentation",description:"",content:`

public virtual byte[] SerializeUserdata(T value)
public virtual IntPtr SerializeUserdata(T value, bool destroy = true)

Serialize arbitary userdata

Parameters

Name	Type	Description
value	<T>	byte array data of value
destroy	Boolean	true to call the DestroyStructure(IntPtr, Type) method.

Returns

Type	Description
Byte[]	byte array representation of userdata value
IntPtr

Variants

SerializeUserdata(value)

public virtual byte[] SerializeUserdata(T value)

Serialize arbitary userdata

Parameters

Name	Type	Description
value	<T>	byte array data of value

Returns

Type	Description
Byte[]	byte array representation of userdata value

SerializeUserdata(value, destroy)

public virtual IntPtr SerializeUserdata(T value, bool destroy = true)

Serialize arbitary userdata

Warning

When the memory block already contains data and destroy is false can lead to a memory leak

Parameters

Name	Type	Description
value	<T>	object data of value
destroy	Boolean	true to call the DestroyStructure(IntPtr, Type) method.

Returns

Type	Description
IntPtr

`}),e.add({id:2854,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2855,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/server/",title:"Server",section:"ODIN Documentation",description:" Gateway ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string Server

Gateway

Value Type

Type	Description
String

`}),e.add({id:2856,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/server/",title:"Server",section:"ODIN Documentation",description:" Room associated endpoint ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string Server

Room associated endpoint

Value Type

Type	Description
String

`}),e.add({id:2857,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2858,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/server/",title:"Server",section:"ODIN Documentation",description:" Gateway ",content:`

public string Server

Gateway

Value Type

Type	Description
String

`}),e.add({id:2859,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/server/",title:"Server",section:"ODIN Documentation",description:" Room associated endpoint ",content:`

public string Server

Room associated endpoint

Value Type

Type	Description
String

`}),e.add({id:2860,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2861,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/server/",title:"Server",section:"ODIN Documentation",description:" Gateway ",content:`

public string Server

Gateway

Value Type

Type	Description
String

`}),e.add({id:2862,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/server/",title:"Server",section:"ODIN Documentation",description:" Room associated endpoint ",content:`

public string Server

Room associated endpoint

Value Type

Type	Description
String

`}),e.add({id:2863,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2864,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/server/",title:"Server",section:"ODIN Documentation",description:" Gateway ",content:`

public string Server

Gateway

Value Type

Type	Description
String

`}),e.add({id:2865,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/server/",title:"Server",section:"ODIN Documentation",description:" Room associated endpoint ",content:`

public string Server

Room associated endpoint

Value Type

Type	Description
String

`}),e.add({id:2866,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2867,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/server/",title:"Server",section:"ODIN Documentation",description:" Default server url ",content:`

public static string Server { get; set; }

Default server url

Value Type

Type	Description
String

`}),e.add({id:2868,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/server/",title:"Server",section:"ODIN Documentation",description:" Gateway ",content:`

public string Server

Gateway

Value Type

Type	Description
String

`}),e.add({id:2869,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/server/",title:"Server",section:"ODIN Documentation",description:" Room associated endpoint ",content:`

public string Server

Room associated endpoint

Value Type

Type	Description
String

`}),e.add({id:2870,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/serveraddress/",title:"serverAddress",section:"ODIN Documentation",description:"The address of the voice server this room is living on.",content:`

string

The address of the voice server this room is living on.

`}),e.add({id:2871,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinroomconnectionstatechangereason/serverrequested/",title:"ServerRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the server (e.g. peer was kicked) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

ServerRequested = 1

Connection state change was initiated by the server (e.g. peer was kicked)

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:2872,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinroomconnectionstatechangereason/serverrequested/",title:"ServerRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the server (e.g. peer was kicked) ",content:`

ServerRequested = 1

Connection state change was initiated by the server (e.g. peer was kicked)

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:2873,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinroomconnectionstatechangereason/serverrequested/",title:"ServerRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the server (e.g. peer was kicked) ",content:`

ServerRequested = 1

Connection state change was initiated by the server (e.g. peer was kicked)

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:2874,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinroomconnectionstatechangereason/serverrequested/",title:"ServerRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the server (e.g. peer was kicked) ",content:`

ServerRequested = 1

Connection state change was initiated by the server (e.g. peer was kicked)

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:2875,href:"https://www.4players.io/odin/sdk/unity/enums/odinroomconnectionstatechangereason/serverrequested/",title:"ServerRequested",section:"ODIN Documentation",description:" Connection state change was initiated by the server (e.g. peer was kicked) ",content:`

ServerRequested = 1

Connection state change was initiated by the server (e.g. peer was kicked)

Value Type

Type	Description
OdinRoomConnectionStateChangeReason

`}),e.add({id:2876,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool SetApmConfig(OdinRoomConfig config)

Set rooms new Apm config

Parameters

Name	Type	Description
config	OdinRoomConfig	new Apm configuration

Returns

Type	Description
Boolean	true on successful set or false

`}),e.add({id:2877,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public bool SetApmConfig(OdinRoomConfig config)

Set rooms new Apm config

Parameters

Name	Type	Description
config	OdinRoomConfig	new Apm configuration

Returns

Type	Description
Boolean	true on successful set or false

`}),e.add({id:2878,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public bool SetApmConfig(OdinRoomConfig config)

Set rooms new Apm config

Parameters

Name	Type	Description
config	OdinRoomConfig	new Apm configuration

Returns

Type	Description
Boolean	true on successful set or false

`}),e.add({id:2879,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public bool SetApmConfig(OdinRoomConfig config)

Set rooms new Apm config

Parameters

Name	Type	Description
config	OdinRoomConfig	new Apm configuration

Returns

Type	Description
Boolean	true on successful set or false

`}),e.add({id:2880,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public override OdinError SetApmConfig(OdinApmConfig config)

Set managed audio processing configuration

Parameters

Name	Type	Description
config	OdinApmConfig	new config

Returns

Type	Description
OdinError	updated config

`}),e.add({id:2881,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public virtual OdinError SetApmConfig(NativeBindings.OdinApmConfig config)

Set native audio processing config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinApmConfig	native config

Returns

Type	Description
OdinError	or error

`}),e.add({id:2882,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public override OdinError SetApmConfig(OdinApmConfig config)

Not supported

Parameters

Name	Type	Description
config	OdinApmConfig

Returns

Type	Description
OdinError

`}),e.add({id:2883,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError SetApmConfig(NativeBindings.OdinApmConfig config)

Set native audio processing config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinApmConfig	native config

Returns

Type	Description
OdinError	or error

`}),e.add({id:2884,href:"https://www.4players.io/odin/sdk/unity/classes/room/setapmconfig/",title:"SetApmConfig",section:"ODIN Documentation",description:"",content:`

public bool SetApmConfig(OdinRoomConfig config)

Set rooms new Apm config

Parameters

Name	Type	Description
config	OdinRoomConfig	new Apm configuration

Returns

Type	Description
Boolean	true on successful set or false

`}),e.add({id:2885,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/setapmstreamdelay/",title:"SetApmStreamDelay",section:"ODIN Documentation",description:"",content:`

public virtual OdinError SetApmStreamDelay(ulong ms)

Set native audio processing delay

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
ms	UInt64	delay

Returns

Type	Description
OdinError	or error

`}),e.add({id:2886,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/setapmstreamdelay/",title:"SetApmStreamDelay",section:"ODIN Documentation",description:"",content:`

public override OdinError SetApmStreamDelay(ulong ms)

Not supported

Parameters

Name	Type	Description
ms	UInt64

Returns

Type	Description
OdinError

`}),e.add({id:2887,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/setapmstreamdelay/",title:"SetApmStreamDelay",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError SetApmStreamDelay(ulong ms)

Set native audio processing delay

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
ms	UInt64	delay

Returns

Type	Description
OdinError	or error

`}),e.add({id:2888,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/setaudioclipdata/",title:"SetAudioClipData",section:"ODIN Documentation",description:"",content:`

public virtual void SetAudioClipData()

`}),e.add({id:2889,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/setaudiosourceptich/",title:"SetAudioSourcePtich",section:"ODIN Documentation",description:"",content:`

public virtual void SetAudioSourcePtich(float audioBufferSize)

Parameters

Name	Type	Description
audioBufferSize	Single

`}),e.add({id:2890,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/setdecoder/",title:"SetDecoder",section:"ODIN Documentation",description:"",content:`

public void SetDecoder(MediaDecoder decoder)

Parameters

Name	Type	Description
decoder	MediaDecoder

`}),e.add({id:2891,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/seteventlistener/",title:"setEventListener",section:"ODIN Documentation",description:"Sets a global event listener that received all events, this can be helpful for debugging. Please use addEventListener instead for production code.",content:`

public setEventListener(callback: (data: OdinEventPayload)=> void)}): void

Sets a global event listener that received all events, this can be helpful for debugging. Please use addEventListener instead for production code.

Parameters

Name	Type	Description
callback	(data: OdinEventPayload)=> void)}	The callback to call when the event is fired.

Returns

Type	Description
void

`}),e.add({id:2892,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudiodata/setframe/",title:"SetFrame",section:"ODIN Documentation",description:"",content:`

public void SetFrame(float[] data, int index, int count)

Parameters

Name	Type	Description
data	Single[]
index	Int32
count	Int32

`}),e.add({id:2893,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/playbackcomponent/setmediainfo/",title:"SetMediaInfo",section:"ODIN Documentation",description:"",content:`

public void SetMediaInfo(string roomName, ulong peerId, long mediaId)

Parameters

Name	Type	Description
roomName	String
peerId	UInt64
mediaId	Int64

`}),e.add({id:2894,href:"https://www.4players.io/odin/sdk/unity/classes/playbackcomponent/setmediainfo/",title:"SetMediaInfo",section:"ODIN Documentation",description:"",content:`

public void SetMediaInfo(string roomName, ulong peerId, long mediaId)

Parameters

Name	Type	Description
roomName	String
peerId	UInt64
mediaId	Int64

`}),e.add({id:2895,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/setmicrophonemute/",title:"SetMicrophoneMute",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool SetMicrophoneMute(bool mute)

Will set the room MicrophoneMedia to mute

Info

Always false if there is no MicrophoneMedia or the room was not joined

Parameters

Name	Type	Description
mute	Boolean	true to mute and false to unmute

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2896,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/setmicrophonemute/",title:"SetMicrophoneMute",section:"ODIN Documentation",description:"",content:`

public bool SetMicrophoneMute(bool mute)

Will set the room MicrophoneMedia to mute

Info

Always false if there is no MicrophoneMedia or the room was not joined

Parameters

Name	Type	Description
mute	Boolean	true to mute and false to unmute

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2897,href:"https://www.4players.io/odin/sdk/unity/classes/room/setmicrophonemute/",title:"SetMicrophoneMute",section:"ODIN Documentation",description:"",content:`

public bool SetMicrophoneMute(bool mute)

Will set the room MicrophoneMedia to mute

Info

Always false if there is no MicrophoneMedia or the room was not joined

Parameters

Name	Type	Description
mute	Boolean	true to mute and false to unmute

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2898,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediacollection/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void SetMute(bool value)

Set IsMuted on each Media

Parameters

Name	Type	Description
value	Boolean	If true, no data will be read/pushed for the media handle

`}),e.add({id:2899,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void SetMute(bool value)

Sets IsMuted.

Parameters

Name	Type	Description
value	Boolean	true for empty data or false

`}),e.add({id:2900,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediacollection/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

public void SetMute(bool value)

Set IsMuted on each Media

Parameters

Name	Type	Description
value	Boolean	If true, no data will be read/pushed for the media handle

`}),e.add({id:2901,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

public void SetMute(bool value)

Sets IsMuted.

Parameters

Name	Type	Description
value	Boolean	true for empty data or false

`}),e.add({id:2902,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

public void SetMute(bool value)

Set IsMuted on each Media

Parameters

Name	Type	Description
value	Boolean	If true, no data will be read/pushed for the media handle

`}),e.add({id:2903,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/setmute/",title:"SetMute",section:"ODIN Documentation",description:"",content:`

public void SetMute(bool value)

Sets IsMuted.

Parameters

Name	Type	Description
value	Boolean	true for empty data or false

`}),e.add({id:2904,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/setmutemedias/",title:"SetMuteMedias",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void SetMuteMedias(bool value)

Set IsMuted on each current associated Media

Info

If true, on the stream no data will be read or pushed even if AudioPushData/AudioReadData is called

Parameters

Name	Type	Description
value	Boolean	true is mute or false

`}),e.add({id:2905,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/setmutemedias/",title:"SetMuteMedias",section:"ODIN Documentation",description:"",content:`

public void SetMuteMedias(bool value)

Set IsMuted on each current associated Media

Info

If true, on the stream no data will be read or pushed even if AudioPushData/AudioReadData is called

Parameters

Name	Type	Description
value	Boolean	true is mute or false

`}),e.add({id:2906,href:"https://www.4players.io/odin/sdk/unity/classes/peer/setmutemedias/",title:"SetMuteMedias",section:"ODIN Documentation",description:"",content:`

public void SetMuteMedias(bool value)

Set IsMuted on each current associated Media

Info

If true, on the stream no data will be read or pushed even if AudioPushData/AudioReadData is called

Parameters

Name	Type	Description
value	Boolean	true is mute or false

`}),e.add({id:2907,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/setpause/",title:"SetPause",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void SetPause(bool value)

Sets IsPaused.

Parameters

Name	Type	Description
value	Boolean	true for NOP or false to call ffi on read/write

`}),e.add({id:2908,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/setpause/",title:"SetPause",section:"ODIN Documentation",description:"",content:`

public void SetPause(bool value)

Sets IsPaused.

Parameters

Name	Type	Description
value	Boolean	true for NOP or false to call ffi on read/write

`}),e.add({id:2909,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/setpause/",title:"SetPause",section:"ODIN Documentation",description:"",content:`

public void SetPause(bool value)

Sets IsPaused.

Parameters

Name	Type	Description
value	Boolean	true for NOP or false to call ffi on read/write

`}),e.add({id:2910,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/setposition/",title:"setPosition",section:"ODIN Documentation",description:"Updates the three-dimensional position of our own `OdinPeer` in the room to apply server-side culling.",content:`

setPosition(offsetX: number, offsetY: number, offsetZ: number): void

Updates the three-dimensional position of our own OdinPeer in the room to apply server-side culling.

Parameters

Name	Type	Description
offsetX	number	The new X coordinate for the peers position in the room
offsetY	number	The new Y coordinate for the peers position in the room
offsetZ	number	The new Z coordinate for the peers position in the room

Returns

Type	Description
void

`}),e.add({id:2911,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/setposition/",title:"SetPosition",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> SetPosition(float x = 0F, float y = 0F)

Set the spatial position for server side culling. Other remote peers outside the boundary will appear as not in the room or leaving the room.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
x	Single	X of vector
y	Single	Y of vector

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2912,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/setpositionscale/",title:"setPositionScale",section:"ODIN Documentation",description:"Sets the scaling factor for coordinates supplied to `updatePosition`, facilitating adaptation to your game's unique coordinate system requirements. Peers are visible to each other only within a unit circle of radius `1.0`. When altering a peer's position, ensure the position is scaled such that the maximum distance remains one or less. This scaling can be performed manually or by specifying the multiplicative scale here. Note: It's crucial to maintain consistent scaling across all client applications.",content:`

public setPositionScale(scale: number): void

Sets the scaling factor for coordinates supplied to updatePosition, facilitating adaptation to your game’s unique coordinate system requirements. Peers are visible to each other only within a unit circle of radius 1.0. When altering a peer’s position, ensure the position is scaled such that the maximum distance remains one or less. This scaling can be performed manually or by specifying the multiplicative scale here.

Note: It’s crucial to maintain consistent scaling across all client applications.

Parameters

Name	Type	Description
scale	number	The new scaling factor to use.

Returns

Type	Description
void

`}),e.add({id:2913,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async void SetPositionScale(float scale)

Updates the Rooms

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2914,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool SetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in the room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2915,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public async void SetPositionScale(float scale)

Updates the Rooms

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2916,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public bool SetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in the room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2917,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public async void SetPositionScale(float scale)

Updates the Rooms

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2918,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public bool SetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in the room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2919,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public async void SetPositionScale(float scale)

Updates the Rooms

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2920,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public bool SetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in the room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2921,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public async void SetPositionScale(float scale)

Updates the Rooms

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

`}),e.add({id:2922,href:"https://www.4players.io/odin/sdk/unity/classes/room/setpositionscale/",title:"SetPositionScale",section:"ODIN Documentation",description:"",content:`

public bool SetPositionScale(float scale)

Configures the allowed 'view' distance for proximity calculation of peers in the room

Info

Make sure that all of your ODIN clients configure the same distance value.

Parameters

Name	Type	Description
scale	Single	Per default, the room will use a distance of `1.0` fo proximity calculation

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:2923,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmediadata/setsamples/",title:"SetSamples",section:"ODIN Documentation",description:"",content:`

public void SetSamples(float[] samples)

Parameters

Name	Type	Description
samples	Single[]

`}),e.add({id:2924,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinconnection/settings/",title:"Settings",section:"ODIN Documentation",description:" Native connection settings ",content:`

public OdinConnectionPoolSettings Settings

Native connection settings

Value Type

Type	Description
OdinConnectionPoolSettings

`}),e.add({id:2925,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odincolliderfiltercomponent/settriggercount/",title:"SetTriggerCount",section:"ODIN Documentation",description:"",content:`

public virtual void SetTriggerCount(Collider obj, bool isEnter)

Parameters

Name	Type	Description
obj	Collider
isEnter	Boolean

`}),e.add({id:2926,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinterrainfiltercomponent/setuserdata/",title:"SetUserData",section:"ODIN Documentation",description:"",content:`

public virtual void SetUserData(Vector3 objectPosition, Vector3 terrainPosition, TerrainData terrainData)

Set delegate userdata for effect callback

Parameters

Name	Type	Description
objectPosition	Vector3
terrainPosition	Vector3
terrainData	TerrainData

`}),e.add({id:2927,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/setvadconfig/",title:"SetVadConfig",section:"ODIN Documentation",description:"",content:`

public override OdinError SetVadConfig(OdinVadConfig config)

Not supported

Parameters

Name	Type	Description
config	OdinVadConfig

Returns

Type	Description
OdinError

`}),e.add({id:2928,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/setvadconfig/",title:"SetVadConfig",section:"ODIN Documentation",description:"",content:`

public virtual OdinError SetVadConfig(NativeBindings.OdinVadConfig config)

Set native voice activity config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinVadConfig	new config

Returns

Type	Description
OdinError	or error

`}),e.add({id:2929,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/setvadconfig/",title:"SetVadConfig",section:"ODIN Documentation",description:"",content:`

public override OdinError SetVadConfig(OdinVadConfig config)

Set managed voice activity configuration

Parameters

Name	Type	Description
config	OdinVadConfig	new config

Returns

Type	Description
OdinError	updated config

`}),e.add({id:2930,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/setvadconfig/",title:"SetVadConfig",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError SetVadConfig(NativeBindings.OdinVadConfig config)

Set native voice activity config

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
config	OdinVadConfig	new config

Returns

Type	Description
OdinError	or error

`}),e.add({id:2931,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/silencecapturedaudio/",title:"SilenceCapturedAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer for PushAudio. ",content:`

public bool SilenceCapturedAudio

Zero out the event audio buffer for PushAudio.

Value Type

Type	Description
Boolean

`}),e.add({id:2932,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/silencecapturedaudio/",title:"SilenceCapturedAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer for PushAudio. ",content:`

public bool SilenceCapturedAudio

Zero out the event audio buffer for PushAudio.

Value Type

Type	Description
Boolean

`}),e.add({id:2933,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/silencecapturedaudio/",title:"SilenceCapturedAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer for PushAudio. ",content:`

public bool SilenceCapturedAudio

Zero out the event audio buffer for PushAudio.

Value Type

Type	Description
Boolean

`}),e.add({id:2934,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/silencecapturedaudio/",title:"SilenceCapturedAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer for PushAudio. ",content:`

public bool SilenceCapturedAudio

Zero out the event audio buffer for PushAudio.

Value Type

Type	Description
Boolean

`}),e.add({id:2935,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/silencecapturedaudio/",title:"SilenceCapturedAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer for PushAudio. ",content:`

public bool SilenceCapturedAudio

Zero out the event audio buffer for PushAudio.

Value Type

Type	Description
Boolean

`}),e.add({id:2936,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinaudioreader/silenceinputaudio/",title:"SilenceInputAudio",section:"ODIN Documentation",description:" Zero out the event audio buffer. ",content:`

public bool SilenceInputAudio

Zero out the event audio buffer.

Value Type

Type	Description
Boolean

`}),e.add({id:2937,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmuteaudiocomponent/silencetoggle/",title:"SilenceToggle",section:"ODIN Documentation",description:"",content:`

public bool SilenceToggle

Value Type

Type	Description
Boolean

`}),e.add({id:2938,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmedia/spatialblend/",title:"SpatialBlend",section:"ODIN Documentation",description:" Property of AudioSource ",content:`

public float SpatialBlend { get; set; }

Property of AudioSource

Value Type

Type	Description
Single

`}),e.add({id:2939,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/start/",title:"start",section:"ODIN Documentation",description:"Starts the media stream by initiating the encoder/decoder and adding it to the room if it belongs to the local peer.",content:`

start(): Promise<void>

Starts the media stream by initiating the encoder/decoder and adding it to the room if it belongs to the local peer.

Returns

Type	Description
Promise<void>

`}),e.add({id:2940,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/started/",title:"started",section:"ODIN Documentation",description:"Indicates whether or not the media is registered in the audio service instance (e.g. started).",content:`

boolean

Indicates whether or not the media is registered in the audio service instance (e.g. started).

`}),e.add({id:2941,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2942,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2943,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2944,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2945,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2946,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/startlisten/",title:"StartListen",section:"ODIN Documentation",description:"",content:`

public bool StartListen()

Start Unity microphone capture

Info

if "Autostart Listen" in Editor component is true, the capture will be called in Unity-Start(void).

Returns

Type	Description
Boolean

`}),e.add({id:2947,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/startmedia/",title:"StartMedia",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> StartMedia(MediaEncoder encoder)
public virtual Task<RpcResult> StartMedia(ushort mediaId, MediaRpcProperties properties)

Send a "StartMedia" RPC to the server to start the encoder for input.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
encoder	MediaEncoder	input media
mediaId	UInt16	id of input media
properties	MediaRpcProperties	arbitrary media data usually to identify the media on lost connections

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

StartMedia(encoder)

public virtual Task<RpcResult> StartMedia(MediaEncoder encoder)

Send a "StartMedia" RPC to the server to start the encoder for input.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
encoder	MediaEncoder	input media

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

StartMedia(mediaId, properties)

public virtual Task<RpcResult> StartMedia(ushort mediaId, MediaRpcProperties properties)

Send a "StartMedia" RPC with custom media-data to the server to start the encoder for input.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
mediaId	UInt16	id of input media
properties	MediaRpcProperties	arbitrary media data usually to identify the media on lost connections

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2948,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/startmedias/",title:"startMedias",section:"ODIN Documentation",description:"Starts all active medias or a list of specific active medias.",content:`

startMedias(mediaIds?: number[]): Promise<void>

Starts all active medias or a list of specific active medias.

Parameters

Name	Type	Description
mediaIds	number[]	Optional list of media IDs to start

Returns

Type	Description
Promise<void>

`}),e.add({id:2949,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/startvadmeter/",title:"startVADMeter",section:"ODIN Documentation",description:"Enables emitting of RNN-based voice activity detection statistics.",content:`

startVADMeter(): void

Enables emitting of RNN-based voice activity detection statistics.

Returns

Type	Description
void

`}),e.add({id:2950,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinconnectionstatechangedeventpayload/state/",title:"state",section:"ODIN Documentation",description:"The new connection state of the room.",content:`

public state: OdinConnectionState

The new connection state of the room.

Value Type

Type	Description
MediaChannels

`}),e.add({id:2954,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/mediachannels/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Defines two (stereo) channels ",content:`

Stereo = 2

Defines two (stereo) channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2955,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/mediachannels/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Defines two (stereo) channels ",content:`

Stereo = 2

Defines two (stereo) channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2956,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/mediachannels/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Defines two (stereo) channels ",content:`

Stereo = 2

Defines two (stereo) channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2957,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediadecoder/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Output channel flag ",content:`

public bool Stereo { get; }

Output channel flag

Value Type

Type	Description
Boolean

`}),e.add({id:2958,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediaencoder/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Input channel flag ",content:`

public bool Stereo { get; }

Input channel flag

Value Type

Type	Description
Boolean

`}),e.add({id:2959,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Room default stereo flag ",content:`

public readonly bool Stereo

Room default stereo flag

Value Type

Type	Description
Boolean

`}),e.add({id:2960,href:"https://www.4players.io/odin/sdk/unity/enums/mediachannels/stereo/",title:"Stereo",section:"ODIN Documentation",description:" Defines two (stereo) channels ",content:`

Stereo = 2

Defines two (stereo) channels

Value Type

Type	Description
MediaChannels

`}),e.add({id:2961,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/stop/",title:"stop",section:"ODIN Documentation",description:"Stops the media stream by terminating the encoder/decoder and removing it from the room if it belongs to the local peer.",content:`

stop(): Promise<void>

Stops the media stream by terminating the encoder/decoder and removing it from the room if it belongs to the local peer.

Returns

Type	Description
Promise<void>

`}),e.add({id:2962,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/microphonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2963,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/microphonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2964,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/microphonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2965,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/microphonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2966,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinmicrophonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2967,href:"https://www.4players.io/odin/sdk/unity/classes/microphonereader/stoplisten/",title:"StopListen",section:"ODIN Documentation",description:"",content:`

public void StopListen()

Stop Unity Microphone capture if this AudioSender created the recording

`}),e.add({id:2968,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/stopmedia/",title:"StopMedia",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> StopMedia(MediaEncoder encoder)
public virtual Task<RpcResult> StopMedia(ushort mediaId)

Send a "StopMedia" to the server to stop the encoder.

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
encoder	MediaEncoder	input media to stop
mediaId	UInt16	raw id to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

StopMedia(encoder)

public virtual Task<RpcResult> StopMedia(MediaEncoder encoder)

Send a "StopMedia" to the server to stop the encoder.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
encoder	MediaEncoder	input media to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

StopMedia(mediaId)

public virtual Task<RpcResult> StopMedia(ushort mediaId)

Send a "StopMedia" to the server to stop the encoder.

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
mediaId	UInt16	raw id to stop

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:2969,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/stopmedias/",title:"stopMedias",section:"ODIN Documentation",description:"Stops all active medias or a list of specific active medias.",content:`

stopMedias(mediaIds?: number[]): Promise<void>

Stops all active medias or a list of specific active medias.

Parameters

Name	Type	Description
mediaIds	number[]	Optional list of media IDs to stop

Returns

Type	Description
Promise<void>

`}),e.add({id:2970,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/stopvadmeter/",title:"stopVADMeter",section:"ODIN Documentation",description:"Disables emitting of RNN-based voice activity detection statistics.",content:`

stopVADMeter(): void

Disables emitting of RNN-based voice activity detection statistics.

Returns

Type	Description
void

`}),e.add({id:2971,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/str16/",title:"Str16",section:"ODIN Documentation",description:"",content:`

public const byte Str16 = 218

Value Type

Type	Description
Byte

`}),e.add({id:2972,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/str32/",title:"Str32",section:"ODIN Documentation",description:"",content:`

public const byte Str32 = 219

Value Type

Type	Description
Byte

`}),e.add({id:2973,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/str8/",title:"Str8",section:"ODIN Documentation",description:"",content:`

public const byte Str8 = 217

Value Type

Type	Description
Byte

`}),e.add({id:2974,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Type	Description
Android	SupportedPlatform
MacOSX	SupportedPlatform
Linux	SupportedPlatform
Windows	SupportedPlatform

`}),e.add({id:2975,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Type	Description
Android	SupportedPlatform
iOS	SupportedPlatform
MacOSX	SupportedPlatform
Linux	SupportedPlatform
Windows	SupportedPlatform

`}),e.add({id:2976,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Type	Description
Android	SupportedPlatform
MacOSX	SupportedPlatform
Linux	SupportedPlatform
Windows	SupportedPlatform

`}),e.add({id:2977,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Description
Android
iOS
MacOSX
Linux
Windows

`}),e.add({id:2978,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Description
Android
iOS
MacOSX
Linux
Windows

`}),e.add({id:2979,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/",title:"SupportedPlatform",section:"ODIN Documentation",description:" Platforms supported by the native ODIN runtime ",content:`

public enum SupportedPlatform

Platforms supported by the native ODIN runtime

Properties

Name	Description
Android
iOS
MacOSX
Linux
Windows

`}),e.add({id:2980,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediacollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2981,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peercollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2982,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomcollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2983,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediacollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2984,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peercollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2985,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomcollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2986,href:"https://www.4players.io/odin/sdk/unity/classes/mediacollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2987,href:"https://www.4players.io/odin/sdk/unity/classes/peercollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2988,href:"https://www.4players.io/odin/sdk/unity/classes/roomcollection/system.collections.ienumerable.getenumerator/",title:"System.Collections.IEnumerable.GetEnumerator",section:"ODIN Documentation",description:"",content:`

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

`}),e.add({id:2989,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinconnectionstatechangedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2990,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odineventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2991,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinjoinedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2992,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinlefteventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2993,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaactivityeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2994,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaaddedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2995,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmediaremovedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2996,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinmessagereceivedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2997,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2998,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerlefteventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:2999,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeeruserdatachangedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:3e3,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinroomuserdatachangedeventpayload/tag/",title:"tag",section:"ODIN Documentation",description:"An internal integer representing the type of the event. This is mainly used internally for testing purposes.",content:`

public tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

`}),e.add({id:3001,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/",title:"TerrainFilterUserData",section:"ODIN Documentation",description:"",content:`

public struct TerrainFilterUserData

Properties

Name	Description
ObjectPosition	Original source
TerrainPosition	Original terrain
MapPosition	Relative position
X	relative position to alphamap width
Y	relative position to alphamap layers
Z	relative position to alphamap height

`}),e.add({id:3002,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/terrainposition/",title:"TerrainPosition",section:"ODIN Documentation",description:" Original terrain ",content:`

public Vector3 TerrainPosition

Original terrain

Value Type

Type	Description
Vector3

`}),e.add({id:3003,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/test/",title:"Test",section:"ODIN Documentation",description:"",content:`

public static bool Test(bool condition, string message)

Parameters

Name	Type	Description
condition	Boolean
message	String

Returns

Type	Description
Boolean

`}),e.add({id:3004,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/timestamp/",title:"timestamp",section:"ODIN Documentation",description:"",content:`

public Int32 timestamp

Value Type

Type	Description
Int32

`}),e.add({id:3005,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramsend/timestamp/",title:"timestamp",section:"ODIN Documentation",description:"",content:`

public Int32 timestamp

Value Type

Type	Description
Int32

`}),e.add({id:3006,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3007,href:"https://www.4players.io/odin/sdk/unity/1.1.0/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3008,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3009,href:"https://www.4players.io/odin/sdk/unity/1.5.8/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3010,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3011,href:"https://www.4players.io/odin/sdk/unity/1.6.0/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3012,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3013,href:"https://www.4players.io/odin/sdk/unity/1.6.6/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3014,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3015,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3016,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

public virtual byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3017,href:"https://www.4players.io/odin/sdk/unity/interfaces/iuserdata/tobytes/",title:"ToBytes",section:"ODIN Documentation",description:"",content:`

byte[] ToBytes()

Used for converting Data on network level

Returns

Type	Description
Byte[]	arbitrary data

`}),e.add({id:3018,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/togglemute/",title:"ToggleMute",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void ToggleMute()

Toggles IsMuted.

`}),e.add({id:3019,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/togglemute/",title:"ToggleMute",section:"ODIN Documentation",description:"",content:`

public void ToggleMute()

Toggles IsMuted.

`}),e.add({id:3020,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/togglemute/",title:"ToggleMute",section:"ODIN Documentation",description:"",content:`

public void ToggleMute()

Toggles IsMuted.

`}),e.add({id:3021,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/togglepause/",title:"TogglePause",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void TogglePause()

Toggles IsPaused.

`}),e.add({id:3022,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/togglepause/",title:"TogglePause",section:"ODIN Documentation",description:"",content:`

public void TogglePause()

Toggles IsPaused.

`}),e.add({id:3023,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/togglepause/",title:"TogglePause",section:"ODIN Documentation",description:"",content:`

public void TogglePause()

Toggles IsPaused.

`}),e.add({id:3024,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/tohex/",title:"ToHex",section:"ODIN Documentation",description:"",content:`

public string ToHex()

String representation of the stream in hex

Returns

Type	Description
String	hex string of stream

`}),e.add({id:3025,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/token/",title:"Token",section:"ODIN Documentation",description:" Room token ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string Token

Room token

Value Type

Type	Description
String

`}),e.add({id:3026,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/token/",title:"Token",section:"ODIN Documentation",description:" Room token ",content:`

public string Token

Room token

Value Type

Type	Description
String

`}),e.add({id:3027,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/token/",title:"Token",section:"ODIN Documentation",description:" Room token ",content:`

public string Token

Room token

Value Type

Type	Description
String

`}),e.add({id:3028,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/token/",title:"Token",section:"ODIN Documentation",description:" Room token ",content:`

public string Token

Room token

Value Type

Type	Description
String

`}),e.add({id:3029,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/token/",title:"Token",section:"ODIN Documentation",description:" Odin room token ",content:`

public string Token

Odin room token

Value Type

Type	Description
String

`}),e.add({id:3030,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/token/",title:"Token",section:"ODIN Documentation",description:" Room joining token ",content:`

public string Token { get; }

Room joining token

Value Type

Type	Description
String

`}),e.add({id:3031,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/token/",title:"Token",section:"ODIN Documentation",description:" Room token ",content:`

public string Token

Room token

Value Type

Type	Description
String

`}),e.add({id:3032,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3033,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Time untill the token expires ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong TokenLifetime

Time untill the token expires

Value Type

Type	Description
UInt64

`}),e.add({id:3034,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Room associated Token lifetime ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public ulong TokenLifetime

Room associated Token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3035,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3036,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Time untill the token expires ",content:`

public ulong TokenLifetime

Time untill the token expires

Value Type

Type	Description
UInt64

`}),e.add({id:3037,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Room associated Token lifetime ",content:`

public ulong TokenLifetime

Room associated Token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3038,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3039,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Time untill the token expires ",content:`

public ulong TokenLifetime

Time untill the token expires

Value Type

Type	Description
UInt64

`}),e.add({id:3040,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Room associated Token lifetime ",content:`

public ulong TokenLifetime

Room associated Token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3041,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3042,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Time untill the token expires ",content:`

public ulong TokenLifetime

Time untill the token expires

Value Type

Type	Description
UInt64

`}),e.add({id:3043,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Room associated Token lifetime ",content:`

public ulong TokenLifetime

Room associated Token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3044,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3045,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" JWT room token lifetime ",content:`

public static ulong TokenLifetime { get; set; }

JWT room token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3046,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Time untill the token expires ",content:`

public ulong TokenLifetime

Time untill the token expires

Value Type

Type	Description
UInt64

`}),e.add({id:3047,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/tokenlifetime/",title:"TokenLifetime",section:"ODIN Documentation",description:" Room associated Token lifetime ",content:`

public ulong TokenLifetime

Room associated Token lifetime

Value Type

Type	Description
UInt64

`}),e.add({id:3048,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/mediastream/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3049,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinmediaconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3050,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3051,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3052,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3053,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/roomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3054,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3055,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/mediastream/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3056,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinmediaconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3057,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3058,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3059,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3060,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/roomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3061,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3062,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/mediastream/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3063,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinmediaconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3064,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3065,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3066,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3067,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/roomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3068,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3069,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/mediastream/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3070,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinmediaconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3071,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3072,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3073,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3074,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/roomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3075,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3076,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of the stream based on encoding (default UTF8)

Returns

Type	Description
String	string of stream

`}),e.add({id:3077,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3078,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3079,href:"https://www.4players.io/odin/sdk/unity/classes/mediastream/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3080,href:"https://www.4players.io/odin/sdk/unity/classes/odinmediaconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3081,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3082,href:"https://www.4players.io/odin/sdk/unity/classes/peer/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3083,href:"https://www.4players.io/odin/sdk/unity/classes/room/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3084,href:"https://www.4players.io/odin/sdk/unity/classes/roomconfig/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

Debug

Returns

Type	Description
String	info

`}),e.add({id:3085,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/tostring/",title:"ToString",section:"ODIN Documentation",description:"",content:`

public override string ToString()

String representation of Buffer based on the specified encoding

Returns

Type	Description
String	string representation

`}),e.add({id:3086,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinapmconfig/transient_suppressor/",title:"transient_suppressor",section:"ODIN Documentation",description:"",content:`

public bool transient_suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3087,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/transientsuppressor/",title:"transientSuppressor",section:"ODIN Documentation",description:"Enable or disable the transient suppressor",content:`

public transientSuppressor: boolean

Enable or disable the transient suppressor

`}),e.add({id:3088,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3089,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Filters high amplitude noices ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool TransientSuppressor

Filters high amplitude noices

Value Type

Type	Description
Boolean

`}),e.add({id:3090,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Enable or disable the transient suppressor ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool TransientSuppressor { get; set; }

Enable or disable the transient suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3091,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3092,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Filters high amplitude noices ",content:`

public bool TransientSuppressor

Filters high amplitude noices

Value Type

Type	Description
Boolean

`}),e.add({id:3093,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Enable or disable the transient suppressor ",content:`

public bool TransientSuppressor { get; set; }

Enable or disable the transient suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3094,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3095,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Filters high amplitude noices ",content:`

public bool TransientSuppressor

Filters high amplitude noices

Value Type

Type	Description
Boolean

`}),e.add({id:3096,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Enable or disable the transient suppressor ",content:`

public bool TransientSuppressor { get; set; }

Enable or disable the transient suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3097,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3098,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Filters high amplitude noices ",content:`

public bool TransientSuppressor

Filters high amplitude noices

Value Type

Type	Description
Boolean

`}),e.add({id:3099,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Enable or disable the transient suppressor ",content:`

public bool TransientSuppressor { get; set; }

Enable or disable the transient suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3100,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled ",content:`

public bool TransientSuppressor { get; set; }

Idicates whether the ApmConfig setting is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:3101,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:"",content:`

public bool TransientSuppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3102,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3103,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool TransientSuppressor

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3104,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Filters high amplitude noices ",content:`

public bool TransientSuppressor

Filters high amplitude noices

Value Type

Type	Description
Boolean

`}),e.add({id:3105,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/transientsuppressor/",title:"TransientSuppressor",section:"ODIN Documentation",description:" Enable or disable the transient suppressor ",content:`

public bool TransientSuppressor { get; set; }

Enable or disable the transient suppressor

Value Type

Type	Description
Boolean

`}),e.add({id:3106,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/true/",title:"True",section:"ODIN Documentation",description:"",content:`

public const byte True = 195

Value Type

Type	Description
Byte

`}),e.add({id:3107,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3108,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3109,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3110,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3111,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3112,href:"https://www.4players.io/odin/sdk/unity/classes/odinlibraryparameters/trygetnativebinaryname/",title:"TryGetNativeBinaryName",section:"ODIN Documentation",description:"",content:`

public static bool TryGetNativeBinaryName(out string[] names, out SupportedPlatform platform)

Returns the name of the native ODIN runtime binary that fits the current environment

Parameters

Name	Type	Description
names	String[]	possible names of the native sdk binary
platform	SupportedPlatform	detected platform

Returns

Type	Description
Boolean	true if a matching binary exists

`}),e.add({id:3113,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_array/",title:"Type_Array",section:"ODIN Documentation",description:"",content:`

public const byte Type_Array = 7

Value Type

Type	Description
Byte

`}),e.add({id:3114,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_binary/",title:"Type_Binary",section:"ODIN Documentation",description:"",content:`

public const byte Type_Binary = 6

Value Type

Type	Description
Byte

`}),e.add({id:3115,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_boolean/",title:"Type_Boolean",section:"ODIN Documentation",description:"",content:`

public const byte Type_Boolean = 3

Value Type

Type	Description
Byte

`}),e.add({id:3116,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_extension/",title:"Type_Extension",section:"ODIN Documentation",description:"",content:`

public const byte Type_Extension = 9

Value Type

Type	Description
Byte

`}),e.add({id:3117,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_float/",title:"Type_Float",section:"ODIN Documentation",description:"",content:`

public const byte Type_Float = 4

Value Type

Type	Description
Byte

`}),e.add({id:3118,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_integer/",title:"Type_Integer",section:"ODIN Documentation",description:"",content:`

public const byte Type_Integer = 1

Value Type

Type	Description
Byte

`}),e.add({id:3119,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_map/",title:"Type_Map",section:"ODIN Documentation",description:"",content:`

public const byte Type_Map = 8

Value Type

Type	Description
Byte

`}),e.add({id:3120,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_nil/",title:"Type_Nil",section:"ODIN Documentation",description:"",content:`

public const byte Type_Nil = 2

Value Type

Type	Description
Byte

`}),e.add({id:3121,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_string/",title:"Type_String",section:"ODIN Documentation",description:"",content:`

public const byte Type_String = 5

Value Type

Type	Description
Byte

`}),e.add({id:3122,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/type_unknown/",title:"Type_Unknown",section:"ODIN Documentation",description:"",content:`

public const byte Type_Unknown = 0

Value Type

Type	Description
Byte

`}),e.add({id:3123,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/messagepackextension/typecode/",title:"TypeCode",section:"ODIN Documentation",description:"",content:`

public sbyte TypeCode

Value Type

Type	Description
SByte

`}),e.add({id:3124,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcformat/typeindex/",title:"TypeIndex",section:"ODIN Documentation",description:" PositiveFixInt field (type) ",content:`

public const int TypeIndex = 0

PositiveFixInt field (type)

Value Type

Type	Description
Int32

`}),e.add({id:3125,href:"https://www.4players.io/odin/sdk/nodejs/types/",title:"Types",section:"ODIN Documentation",description:"An index of all Types available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Types:

OdinAudioDataReceivedEvent

OdinConnectionState

OdinConnectionStateChangeReason

OdinJoinedEvent

OdinLeftEvent

OdinMediaActivityEvent

OdinMediaAddedEvent

OdinMediaRemovedEvent

OdinMessageReceivedEvent

OdinPeerJoinedEvent

OdinPeerLeftEvent

OdinPeerUserDataChangedEvent

OdinRoomUserDataChangedEvent

`}),e.add({id:3126,href:"https://www.4players.io/odin/sdk/web/types/",title:"Types",section:"ODIN Documentation",description:"An index of all Types available in the ODIN Unity SDK",content:`

The ODIN JavaScript SDK has defined these Types:

OdinAudioStatsEvent

OdinConnectionState

OdinConnectionStateChangedEvent

OdinMediaActivityChangedEvent

OdinMediaStartedStoppedEvent

OdinMessageReceivedEvent

OdinPeerDataChangedEvent

OdinPeerJoinedLeftEvent

OdinRoomDataChangedEvent

OdinRoomJoinedLeftEvent

`}),e.add({id:3127,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_rx_acks/",title:"udp_rx_acks",section:"ODIN Documentation",description:" The amount of incoming acknowledgement frames observed ",content:`

public ulong udp_rx_acks

The amount of incoming acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3128,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_rx_acks/",title:"udp_rx_acks",section:"ODIN Documentation",description:" The amount of incoming acknowledgement frames observed ",content:`

public ulong udp_rx_acks

The amount of incoming acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3129,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_rx_acks/",title:"udp_rx_acks",section:"ODIN Documentation",description:" The amount of incoming acknowledgement frames observed ",content:`

public ulong udp_rx_acks

The amount of incoming acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3130,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_rx_bytes/",title:"udp_rx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside incoming UDP datagrams ",content:`

public ulong udp_rx_bytes

The total amount of bytes which have been transferred inside incoming UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3131,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_rx_bytes/",title:"udp_rx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside incoming UDP datagrams ",content:`

public ulong udp_rx_bytes

The total amount of bytes which have been transferred inside incoming UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3132,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_rx_bytes/",title:"udp_rx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside incoming UDP datagrams ",content:`

public ulong udp_rx_bytes

The total amount of bytes which have been transferred inside incoming UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3133,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_rx_datagrams/",title:"udp_rx_datagrams",section:"ODIN Documentation",description:" The amount of incoming UDP datagrams observed ",content:`

public ulong udp_rx_datagrams

The amount of incoming UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3134,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_rx_datagrams/",title:"udp_rx_datagrams",section:"ODIN Documentation",description:" The amount of incoming UDP datagrams observed ",content:`

public ulong udp_rx_datagrams

The amount of incoming UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3135,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_rx_datagrams/",title:"udp_rx_datagrams",section:"ODIN Documentation",description:" The amount of incoming UDP datagrams observed ",content:`

public ulong udp_rx_datagrams

The amount of incoming UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3136,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_tx_acks/",title:"udp_tx_acks",section:"ODIN Documentation",description:" The amount of outgoing acknowledgement frames observed ",content:`

public ulong udp_tx_acks

The amount of outgoing acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3137,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_tx_acks/",title:"udp_tx_acks",section:"ODIN Documentation",description:" The amount of outgoing acknowledgement frames observed ",content:`

public ulong udp_tx_acks

The amount of outgoing acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3138,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_tx_acks/",title:"udp_tx_acks",section:"ODIN Documentation",description:" The amount of outgoing acknowledgement frames observed ",content:`

public ulong udp_tx_acks

The amount of outgoing acknowledgement frames observed

Value Type

Type	Description
UInt64

`}),e.add({id:3139,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_tx_bytes/",title:"udp_tx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside outgoing UDP datagrams ",content:`

public ulong udp_tx_bytes

The total amount of bytes which have been transferred inside outgoing UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3140,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_tx_bytes/",title:"udp_tx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside outgoing UDP datagrams ",content:`

public ulong udp_tx_bytes

The total amount of bytes which have been transferred inside outgoing UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3141,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_tx_bytes/",title:"udp_tx_bytes",section:"ODIN Documentation",description:" The total amount of bytes which have been transferred inside outgoing UDP datagrams ",content:`

public ulong udp_tx_bytes

The total amount of bytes which have been transferred inside outgoing UDP datagrams

Value Type

Type	Description
UInt64

`}),e.add({id:3142,href:"https://www.4players.io/odin/sdk/unity/1.5.8/structs/odinconnectionstats/udp_tx_datagrams/",title:"udp_tx_datagrams",section:"ODIN Documentation",description:" The amount of outgoing UDP datagrams observed ",content:`

public ulong udp_tx_datagrams

The amount of outgoing UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3143,href:"https://www.4players.io/odin/sdk/unity/1.6.6/structs/odinconnectionstats/udp_tx_datagrams/",title:"udp_tx_datagrams",section:"ODIN Documentation",description:" The amount of outgoing UDP datagrams observed ",content:`

public ulong udp_tx_datagrams

The amount of outgoing UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3144,href:"https://www.4players.io/odin/sdk/unity/structs/odinconnectionstats/udp_tx_datagrams/",title:"udp_tx_datagrams",section:"ODIN Documentation",description:" The amount of outgoing UDP datagrams observed ",content:`

public ulong udp_tx_datagrams

The amount of outgoing UDP datagrams observed

Value Type

Type	Description
UInt64

`}),e.add({id:3145,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/mediarpcproperties/uid/",title:"uId",section:"ODIN Documentation",description:" preset field of an unique id ",content:`

public string uId

preset field of an unique id

Value Type

Type	Description
String

`}),e.add({id:3146,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/uint16/",title:"Uint16",section:"ODIN Documentation",description:"",content:`

public const byte Uint16 = 205

Value Type

Type	Description
Byte

`}),e.add({id:3147,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/uint32/",title:"Uint32",section:"ODIN Documentation",description:"",content:`

public const byte Uint32 = 206

Value Type

Type	Description
Byte

`}),e.add({id:3148,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/uint64/",title:"Uint64",section:"ODIN Documentation",description:"",content:`

public const byte Uint64 = 207

Value Type

Type	Description
Byte

`}),e.add({id:3149,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpacktoken/uint8/",title:"Uint8",section:"ODIN Documentation",description:"",content:`

public const byte Uint8 = 204

Value Type

Type	Description
Byte

`}),e.add({id:3150,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/unityaudiodata/",title:"UnityAudioData",section:"ODIN Documentation",description:"",content:`

public class UnityAudioData : UnityEvent<float[], int, bool>

`}),e.add({id:3151,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/unityaudiosourcetag/",title:"UnityAudioSourceTag",section:"ODIN Documentation",description:" Identify by Unity-Tag to attach a ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public readonly string UnityAudioSourceTag

Identify by Unity-Tag to attach a Audio

Info

Currently no effect

Value Type

Type	Description
String

`}),e.add({id:3152,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/unityaudiosourcetag/",title:"UnityAudioSourceTag",section:"ODIN Documentation",description:" Identify by Unity-Tag to attach a ",content:`

public readonly string UnityAudioSourceTag

Identify by Unity-Tag to attach a Audio

Info

Currently no effect

Value Type

Type	Description
String

`}),e.add({id:3153,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/unityaudiosourcetag/",title:"UnityAudioSourceTag",section:"ODIN Documentation",description:" Identify by Unity-Tag to attach a ",content:`

public readonly string UnityAudioSourceTag

Identify by Unity-Tag to attach a Audio

Info

Currently no effect

Value Type

Type	Description
String

`}),e.add({id:3154,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/unityaudiosourcetag/",title:"UnityAudioSourceTag",section:"ODIN Documentation",description:" Identify by Unity-Tag to attach a ",content:`

public readonly string UnityAudioSourceTag

Identify by Unity-Tag to attach a Audio

Info

Currently no effect

Value Type

Type	Description
String

`}),e.add({id:3155,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/unityaudiosourcetag/",title:"UnityAudioSourceTag",section:"ODIN Documentation",description:" Identify by Unity-Tag to attach a ",content:`

public readonly string UnityAudioSourceTag

Identify by Unity-Tag to attach a Audio

Info

Currently no effect

Value Type

Type	Description
String

`}),e.add({id:3156,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class UnityCreatedMediaObject : UnityEvent<string, ulong, long>

`}),e.add({id:3157,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

[Serializable]
public class UnityCreatedMediaObject : UnityEvent<string, ulong, long>

`}),e.add({id:3158,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

public class UnityCreatedMediaObject : UnityEvent<string, ulong, long>

`}),e.add({id:3159,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

[Serializable]
public class UnityCreatedMediaObject : UnityEvent<string, ulong, long>

`}),e.add({id:3160,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

public class UnityCreatedMediaObject : UnityEvent<ulong, ulong, ushort>

`}),e.add({id:3161,href:"https://www.4players.io/odin/sdk/unity/classes/unitycreatedmediaobject/",title:"UnityCreatedMediaObject",section:"ODIN Documentation",description:"",content:`

[Serializable]
public class UnityCreatedMediaObject : UnityEvent<string, ulong, long>

`}),e.add({id:3162,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class UnityDeleteMediaObject : UnityEvent<long>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3163,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class UnityDeleteMediaObject : UnityEvent<long>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3164,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

public class UnityDeleteMediaObject : UnityEvent<long>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3165,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class UnityDeleteMediaObject : UnityEvent<long>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3166,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

public class UnityDeleteMediaObject : UnityEvent<ushort>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3167,href:"https://www.4players.io/odin/sdk/unity/classes/unitydeletemediaobject/",title:"UnityDeleteMediaObject",section:"ODIN Documentation",description:" Unity Inspector event wrapper (UnityEvent) ",content:`

[Serializable]
public class UnityDeleteMediaObject : UnityEvent<long>

Unity Inspector event wrapper (UnityEvent)

`}),e.add({id:3168,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/unlinkinputmedia/",title:"UnlinkInputMedia",section:"ODIN Documentation",description:"",content:`

public virtual bool UnlinkInputMedia(MediaEncoder encoder, bool free = true)

Remove a input media encoder from the corresponding room.

Parameters

Name	Type	Description
encoder	MediaEncoder	input media
free	Boolean	flag if the freed up encoder id will be available for the room again

Returns

Type	Description
Boolean	true on stop or false

`}),e.add({id:3169,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/update/",title:"update",section:"ODIN Documentation",description:"Sends user data of the peer to the server.",content:`

update(): Promise<void>

Sends user data of the peer to the server.

Returns

Type	Description
Promise<void>

`}),e.add({id:3170,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/piplineeffect/updateapmplayback/",title:"UpdateApmPlayback",section:"ODIN Documentation",description:"",content:`

public virtual OdinError UpdateApmPlayback(NativeBindings.OdinAudioReadOnlyData audio)

Send samples for native audio processing

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
audio	OdinAudioReadOnlyData	samples

Returns

Type	Description
OdinError	or error

`}),e.add({id:3171,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/updateapmplayback/",title:"UpdateApmPlayback",section:"ODIN Documentation",description:"",content:`

public override OdinError UpdateApmPlayback(OdinAudioReadOnlyData audio)

Not supported

Parameters

Name	Type	Description
audio	OdinAudioReadOnlyData

Returns

Type	Description
OdinError

`}),e.add({id:3172,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/ipiplineeffect/updateapmplayback/",title:"UpdateApmPlayback",section:"ODIN Documentation",description:"",content:`

NativeBindings.OdinError UpdateApmPlayback(NativeBindings.OdinAudioReadOnlyData audio)

Send samples for native audio processing

Info

Only successful on OdinEffectType

Parameters

Name	Type	Description
audio	OdinAudioReadOnlyData	samples

Returns

Type	Description
OdinError	or error

`}),e.add({id:3173,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinapmcomponent/updateconfig/",title:"UpdateConfig",section:"ODIN Documentation",description:"",content:`

public void UpdateConfig()
public void UpdateConfig(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

Variants

UpdateConfig()

public void UpdateConfig()

UpdateConfig(pipeline)

public void UpdateConfig(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

`}),e.add({id:3174,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/updateconfig/",title:"UpdateConfig",section:"ODIN Documentation",description:"",content:`

public void UpdateConfig()
public void UpdateConfig(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

Variants

UpdateConfig()

public void UpdateConfig()

UpdateConfig(pipeline)

public void UpdateConfig(MediaPipeline pipeline)

Parameters

Name	Type	Description
pipeline	MediaPipeline

`}),e.add({id:3175,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/apmeffect/updateeffectconfig/",title:"UpdateEffectConfig",section:"ODIN Documentation",description:"",content:`

public bool UpdateEffectConfig(MediaPipeline pipeline)

Set audio processing configuration

Parameters

Name	Type	Description
pipeline	MediaPipeline

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:3176,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/updateeffectconfig/",title:"UpdateEffectConfig",section:"ODIN Documentation",description:"",content:`

public bool UpdateEffectConfig()

Set voice activity configuration

Returns

Type	Description
Boolean	true on success or false

`}),e.add({id:3177,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/updateownuserdata/",title:"updateOwnUserData",section:"ODIN Documentation",description:"Updates the peer user data of the local peer",content:`

public updateOwnUserData(userData: Uint8Array): void

Updates the peer user data of the local peer

Parameters

Name	Type	Description
userData	Uint8Array	The new user data to set.

Returns

Type	Description
void

`}),e.add({id:3178,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/updatepeeruserdata/",title:"UpdatePeerUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool UpdatePeerUserData(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the peer or false

`}),e.add({id:3179,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/updatepeeruserdata/",title:"UpdatePeerUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdatePeerUserData(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the peer or false

`}),e.add({id:3180,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/updatepeeruserdata/",title:"UpdatePeerUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdatePeerUserData(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the peer or false

`}),e.add({id:3181,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/updatepeeruserdata/",title:"UpdatePeerUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdatePeerUserData(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the peer or false

`}),e.add({id:3182,href:"https://www.4players.io/odin/sdk/unity/classes/room/updatepeeruserdata/",title:"UpdatePeerUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdatePeerUserData(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the peer or false

`}),e.add({id:3183,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/updatepeeruserdataasync/",title:"UpdatePeerUserDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the peer or false

`}),e.add({id:3184,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/updatepeeruserdataasync/",title:"UpdatePeerUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the peer or false

`}),e.add({id:3185,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/updatepeeruserdataasync/",title:"UpdatePeerUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the peer or false

`}),e.add({id:3186,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/updatepeeruserdataasync/",title:"UpdatePeerUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the peer or false

`}),e.add({id:3187,href:"https://www.4players.io/odin/sdk/unity/classes/room/updatepeeruserdataasync/",title:"UpdatePeerUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdatePeerUserDataAsync(IUserData userData)

Updates the user data for our own peer. The server will populate this data to all other visible peers in the same room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the peer or false

`}),e.add({id:3188,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odindatagramrecv/updatepinnedpayload/",title:"UpdatePinnedPayload",section:"ODIN Documentation",description:"",content:`

public GCHandle UpdatePinnedPayload(byte[] data)

Parameters

Name	Type	Description
data	Byte[]

Returns

Type	Description
GCHandle

`}),e.add({id:3189,href:"https://www.4players.io/odin/sdk/nodejs/classes/odinroom/updateposition/",title:"updatePosition",section:"ODIN Documentation",description:"Updates the three-dimensional position of the current peer in this room. The server utilizes the provided coordinates to perform automatic culling among peers in the same room, based on unit circles with a radius of `1.0`. This feature is particularly beneficial in scenarios involving a large number of peers within the same room, enabling peers to interact or 'see' each other only when in close proximity. To modify the distance sensitivity for position updates, use `setPositionScale`. Note: Use this before calling `join` to set the initial peer position upon connect.",content:`

public updatePosition(x: number, y: number, z: number): void

Updates the three-dimensional position of the current peer in this room. The server utilizes the provided coordinates to perform automatic culling among peers in the same room, based on unit circles with a radius of 1.0. This feature is particularly beneficial in scenarios involving a large number of peers within the same room, enabling peers to interact or ‘see’ each other only when in close proximity. To modify the distance sensitivity for position updates, use setPositionScale.

Note: Use this before calling join to set the initial peer position upon connect.

Parameters

Name	Type	Description
x	number	The new x position of the peer.
y	number	The new y position of the peer.
z	number	The new z position of the peer.

Returns

Type	Description
void

`}),e.add({id:3190,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async void UpdatePosition(float x, float y)

Updates the Rooms

Info

This should only be used after configuring the room with SetPositionScale(System.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:3191,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool UpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in the room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:3192,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public async void UpdatePosition(float x, float y)

Updates the Rooms

Info

This should only be used after configuring the room with SetPositionScale(System.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:3193,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public bool UpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in the room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:3194,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public async void UpdatePosition(float x, float y)

Updates the Rooms

Info

This should only be used after configuring the room with SetPositionScale(System.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:3195,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public bool UpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in the room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:3196,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public async void UpdatePosition(float x, float y)

Updates the Rooms

Info

This should only be used after configuring the room with SetPositionScale(System.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:3197,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/room/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public bool UpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in the room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:3198,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public async void UpdatePosition(float x, float y)

Updates the Rooms

Info

This should only be used after configuring the room with SetPositionScale(System.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

`}),e.add({id:3199,href:"https://www.4players.io/odin/sdk/unity/classes/room/updateposition/",title:"UpdatePosition",section:"ODIN Documentation",description:"",content:`

public bool UpdatePosition(float x, float y)

Updates the two-dimensional position of our own peer in the room

Info

This should only be used after configuring the room with RoomSetPositionScale(RoomHandle%2cSystem.

Parameters

Name	Type	Description
x	Single	x postition
y	Single	y postition

Returns

Type	Description
Boolean	true if set or false

`}),e.add({id:3200,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/updateroomuserdata/",title:"UpdateRoomUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool UpdateRoomUserData(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the room or false

`}),e.add({id:3201,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/updateroomuserdata/",title:"UpdateRoomUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdateRoomUserData(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the room or false

`}),e.add({id:3202,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/updateroomuserdata/",title:"UpdateRoomUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdateRoomUserData(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the room or false

`}),e.add({id:3203,href:"https://www.4players.io/odin/sdk/unity/classes/room/updateroomuserdata/",title:"UpdateRoomUserData",section:"ODIN Documentation",description:"",content:`

public bool UpdateRoomUserData(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Boolean	true if userdata was set for the room or false

`}),e.add({id:3204,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/room/updateroomuserdataasync/",title:"UpdateRoomUserDataAsync",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async Task<bool> UpdateRoomUserDataAsync(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the room or false

`}),e.add({id:3205,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/room/updateroomuserdataasync/",title:"UpdateRoomUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdateRoomUserDataAsync(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the room or false

`}),e.add({id:3206,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/room/updateroomuserdataasync/",title:"UpdateRoomUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdateRoomUserDataAsync(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the room or false

`}),e.add({id:3207,href:"https://www.4players.io/odin/sdk/unity/classes/room/updateroomuserdataasync/",title:"UpdateRoomUserDataAsync",section:"ODIN Documentation",description:"",content:`

public async Task<bool> UpdateRoomUserDataAsync(IUserData userData)

Updates the user data for the current room.

Parameters

Name	Type	Description
userData	IUserData	Userdata to send

Returns

Type	Description
Task<Boolean>	true if userdata was set for the room or false

`}),e.add({id:3208,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public async void UpdateUserData(IUserData userData)

Updates the Rooms for the current peer

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3209,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public void UpdateUserData(IUserData userData)

Updates the UserData for all Rooms

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3210,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public async void UpdateUserData(IUserData userData)

Updates the Rooms for the current peer

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3211,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public void UpdateUserData(IUserData userData)

Updates the Rooms

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3212,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public async void UpdateUserData(IUserData userData)

Updates the Rooms for the current peer

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3213,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public void UpdateUserData(IUserData userData)

Updates the Rooms

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3214,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public async void UpdateUserData(IUserData userData)

Updates the Rooms for the current peer

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3215,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public void UpdateUserData(IUserData userData)

Updates the Rooms

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3216,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/room/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public virtual Task<RpcResult> UpdateUserData(IUserData userData)
public virtual Task<RpcResult> UpdateUserData(byte[] bytes)

Update arbitrary userdata of self (note: Odin)

Info

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
userData	IUserData	arbitrary data
bytes	Byte[]	raw binary data

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

Variants

UpdateUserData(userData)

public virtual Task<RpcResult> UpdateUserData(IUserData userData)

Update arbitrary userdata of self (note: Odin)

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
userData	IUserData	arbitrary data

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

UpdateUserData(bytes)

public virtual Task<RpcResult> UpdateUserData(byte[] bytes)

Update binary userdata of self (note: Odin)

Warning

Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.

Parameters

Name	Type	Description
bytes	Byte[]	raw binary data

Returns

Type	Description
Task<RpcResult>	Thunk task that will not run (see )

`}),e.add({id:3217,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public async void UpdateUserData(IUserData userData)

Updates the Rooms for the current peer

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3218,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/updateuserdata/",title:"UpdateUserData",section:"ODIN Documentation",description:"",content:`

public void UpdateUserData(IUserData userData)

Updates the Rooms

Parameters

Name	Type	Description
userData	IUserData

`}),e.add({id:3219,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/updatevadthresholds/",title:"updateVADThresholds",section:"ODIN Documentation",description:"Updates thresholds for vice activity detection (between 0 and 1).",content:`

updateVADThresholds(attackProbability: number, releaseProbability?: number): void

Updates thresholds for vice activity detection (between 0 and 1).

Parameters

Name	Type	Description
attackProbability	number	Voice probability value when the VAD should engage
releaseProbability	number	Voice probability value when the VAD should disengage

Returns

Type	Description
void

`}),e.add({id:3220,href:"https://www.4players.io/odin/sdk/web/classes/odinroom/updatevolumegatethresholds/",title:"updateVolumeGateThresholds",section:"ODIN Documentation",description:"Updates thresholds for the input volume gate (between -90 and 0).",content:`

updateVolumeGateThresholds(attackLoudness: number, releaseLoudness?: number): void

Updates thresholds for the input volume gate (between -90 and 0).

Parameters

Name	Type	Description
attackLoudness	number	Root mean square power (dBFS) when the volume gate should engage
releaseLoudness	number	Root mean square power (dBFS) when the volume gate should disengage

Returns

Type	Description
void

`}),e.add({id:3221,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinhandler/use3daudio/",title:"Use3DAudio",section:"ODIN Documentation",description:" Enable 3D Audio via preset ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Use3DAudio

Enable 3D Audio via preset Odin

Info

Currently no effect

Value Type

Type	Description
Boolean

`}),e.add({id:3222,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinhandler/use3daudio/",title:"Use3DAudio",section:"ODIN Documentation",description:" Enable 3D Audio via preset ",content:`

public bool Use3DAudio

Enable 3D Audio via preset Odin

Info

Currently no effect

Value Type

Type	Description
Boolean

`}),e.add({id:3223,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinhandler/use3daudio/",title:"Use3DAudio",section:"ODIN Documentation",description:" Enable 3D Audio via preset ",content:`

public bool Use3DAudio

Enable 3D Audio via preset Odin

Info

Currently no effect

Value Type

Type	Description
Boolean

`}),e.add({id:3224,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinhandler/use3daudio/",title:"Use3DAudio",section:"ODIN Documentation",description:" Enable 3D Audio via preset ",content:`

public bool Use3DAudio

Enable 3D Audio via preset Odin

Info

Currently no effect

Value Type

Type	Description
Boolean

`}),e.add({id:3225,href:"https://www.4players.io/odin/sdk/unity/classes/odinhandler/use3daudio/",title:"Use3DAudio",section:"ODIN Documentation",description:" Enable 3D Audio via preset ",content:`

public bool Use3DAudio

Enable 3D Audio via preset Odin

Info

Currently no effect

Value Type

Type	Description
Boolean

`}),e.add({id:3226,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinconnectionpoolsettings/user_data/",title:"user_data",section:"ODIN Documentation",description:" IntPtr ",content:`

public MarshalByRefObject user_data

IntPtr

Value Type

Type	Description
MarshalByRefObject

`}),e.add({id:3227,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/userdata/",title:"userData",section:"ODIN Documentation",description:"The user data of the peer that joined.",content:`

public userData: undefined | Uint8Array

The user data of the peer that joined.

`}),e.add({id:3228,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeeruserdatachangedeventpayload/userdata/",title:"userData",section:"ODIN Documentation",description:"The new user data of the peer.",content:`

public userData: undefined | Uint8Array

The new user data of the peer.

`}),e.add({id:3229,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinroomuserdatachangedeventpayload/userdata/",title:"userData",section:"ODIN Documentation",description:"The new user data of the room.",content:`

public userData: undefined | Uint8Array

The new user data of the room.

`}),e.add({id:3230,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/datagrameventargs/userdata/",title:"Userdata",section:"ODIN Documentation",description:" unused ",content:`

public MarshalByRefObject Userdata { get; }

unused

Value Type

Type	Description
MarshalByRefObject

`}),e.add({id:3231,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpceventargs/userdata/",title:"Userdata",section:"ODIN Documentation",description:" unused ",content:`

public MarshalByRefObject Userdata { get; }

unused

Value Type

Type	Description
MarshalByRefObject

`}),e.add({id:3232,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:" Client custom UserData ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public IUserData UserData { get; set; }

Client custom UserData

Value Type

Type	Description
IUserData

`}),e.add({id:3233,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UserData UserData { get; }

Peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3234,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3235,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Properties

Name	Type	Description
Encoding	Encoding	Default Encoding
Buffer	Byte[]	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3236,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:" Client custom UserData ",content:`

public IUserData UserData { get; set; }

Client custom UserData

Value Type

Type	Description
IUserData

`}),e.add({id:3237,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

public UserData UserData { get; }

Peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3238,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3239,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Properties

Name	Type	Description
Encoding	Encoding	Default Encoding
Buffer	Byte[]	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3240,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:" Client custom UserData ",content:`

public IUserData UserData { get; set; }

Client custom UserData

Value Type

Type	Description
IUserData

`}),e.add({id:3241,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

public UserData UserData { get; }

Peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3242,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3243,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Properties

Name	Type	Description
Encoding	Encoding	Default Encoding
Buffer	Byte[]	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3244,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:" Client custom UserData ",content:`

public IUserData UserData { get; set; }

Client custom UserData

Value Type

Type	Description
IUserData

`}),e.add({id:3245,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

public UserData UserData { get; }

Peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3246,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3247,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Constructors

Name	Description
UserData(String)	Odin UserData with default encoding UTF8
UserData(String, Encoding)	Odin UserData with custom encoding
UserData(Byte[])	Odin UserData with default encoding UTF8
UserData(Byte[], Encoding)	Odin UserData with custom encoding

Properties

Name	Description
Encoding	Default Encoding
Buffer	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3248,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:"",content:`

public IUserData UserData { get; }

Value Type

Type	Description
IUserData

`}),e.add({id:3249,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/userdata/",title:"UserData",section:"ODIN Documentation",description:"",content:`

public IUserData UserData { get; }

Value Type

Type	Description
IUserData

`}),e.add({id:3250,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

public IUserData UserData { get; }

Peer userdata

Value Type

Type	Description
IUserData

`}),e.add({id:3251,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:"",content:`

public UserData UserData

Value Type

Type	Description
UserData

`}),e.add({id:3252,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3253,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Constructors

Name	Description
UserData(String)	Odin UserData with default encoding UTF8
UserData(String, Encoding)	Odin UserData with custom encoding
UserData(Byte[])	Odin UserData with default encoding UTF8
UserData(Byte[], Encoding)	Odin UserData with custom encoding

Properties

Name	Description
Encoding	Default Encoding
Buffer	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3254,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/peerrpc/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public byte[] UserData

peer userdata

Value Type

Type	Description
Byte[]

`}),e.add({id:3255,href:"https://www.4players.io/odin/sdk/unity/classes/odinclient/userdata/",title:"UserData",section:"ODIN Documentation",description:" Client custom UserData ",content:`

public IUserData UserData { get; set; }

Client custom UserData

Value Type

Type	Description
IUserData

`}),e.add({id:3256,href:"https://www.4players.io/odin/sdk/unity/classes/peer/userdata/",title:"UserData",section:"ODIN Documentation",description:" Peer userdata ",content:`

public UserData UserData { get; }

Peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3257,href:"https://www.4players.io/odin/sdk/unity/classes/peeruserdatachangedeventargs/userdata/",title:"UserData",section:"ODIN Documentation",description:" peer userdata ",content:`

public UserData UserData

peer userdata

Value Type

Type	Description
UserData

`}),e.add({id:3258,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/",title:"UserData",section:"ODIN Documentation",description:" Odin UserData helper for marshal byte arrays ",content:`

public class UserData : IUserData

Odin UserData helper for marshal byte arrays

Constructors

Name	Description
UserData(String)	Odin UserData with default encoding UTF8
UserData(String, Encoding)	Odin UserData with custom encoding
UserData(Byte[])	Odin UserData with default encoding UTF8
UserData(Byte[], Encoding)	Odin UserData with custom encoding

Properties

Name	Description
Encoding	Default Encoding
Buffer	Raw UserData

Public Methods

Name	Description
CopyFrom	Copies data from memory to Buffer
IsEmpty	Indicates whether data is null or empty
Contains	Indicates whether substring occurs
PatternAt	Indicates whether two sequence are equal
Clone	Creates a shallow copy of the Buffer
ToBytes	Used for converting Data on network level
ToString	String representation of Buffer based on the specified encoding

`}),e.add({id:3259,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/constructor_3/",title:"UserData(Byte[], Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
data	raw representation
encoding	custom encoding

`}),e.add({id:3260,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/constructor_3/",title:"UserData(Byte[], Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
data	raw representation
encoding	custom encoding

`}),e.add({id:3261,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/constructor_3/",title:"UserData(Byte[], Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
data	raw representation
encoding	custom encoding

`}),e.add({id:3262,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/constructor_2/",title:"UserData(Byte[])",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data)

Odin UserData with default encoding UTF8

Parameters

Name	Description
data	raw representation

`}),e.add({id:3263,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/constructor_2/",title:"UserData(Byte[])",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data)

Odin UserData with default encoding UTF8

Parameters

Name	Description
data	raw representation

`}),e.add({id:3264,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/constructor_2/",title:"UserData(Byte[])",section:"ODIN Documentation",description:"",content:`

public UserData(byte[] data)

Odin UserData with default encoding UTF8

Parameters

Name	Description
data	raw representation

`}),e.add({id:3265,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/constructor_1/",title:"UserData(String, Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(string text, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
text	string representation of userdata
encoding	custom encoding

`}),e.add({id:3266,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/constructor_1/",title:"UserData(String, Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(string text, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
text	string representation of userdata
encoding	custom encoding

`}),e.add({id:3267,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/constructor_1/",title:"UserData(String, Encoding)",section:"ODIN Documentation",description:"",content:`

public UserData(string text, Encoding encoding)

Odin UserData with custom encoding

Parameters

Name	Description
text	string representation of userdata
encoding	custom encoding

`}),e.add({id:3268,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/userdata/constructor_0/",title:"UserData(String)",section:"ODIN Documentation",description:"",content:`

public UserData(string text)

Odin UserData with default encoding UTF8

Parameters

Name	Description
text	string representation of userdata

`}),e.add({id:3269,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/userdata/constructor_0/",title:"UserData(String)",section:"ODIN Documentation",description:"",content:`

public UserData(string text)

Odin UserData with default encoding UTF8

Parameters

Name	Description
text	string representation of userdata

`}),e.add({id:3270,href:"https://www.4players.io/odin/sdk/unity/classes/userdata/constructor_0/",title:"UserData(String)",section:"ODIN Documentation",description:"",content:`

public UserData(string text)

Odin UserData with default encoding UTF8

Parameters

Name	Description
text	string representation of userdata

`}),e.add({id:3271,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinpeerevents/userdatachanged/",title:"UserDataChanged",section:"ODIN Documentation",description:"Peer updated its user data.",content:`

OdinPeerDataChangedEvent

Peer updated its user data.

Value Type

Type	Description
String

`}),e.add({id:3274,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default UserData content ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string UserDataText

Default UserData content

Value Type

Type	Description
String

`}),e.add({id:3275,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default text representation of UserData ",content:`

public static string UserDataText { get; set; }

Default text representation of UserData

Value Type

Type	Description
String

`}),e.add({id:3276,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default UserData content ",content:`

public string UserDataText

Default UserData content

Value Type

Type	Description
String

`}),e.add({id:3277,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default text representation of UserData ",content:`

public static string UserDataText { get; set; }

Default text representation of UserData

Value Type

Type	Description
String

`}),e.add({id:3278,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default UserData content ",content:`

public string UserDataText

Default UserData content

Value Type

Type	Description
String

`}),e.add({id:3279,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default text representation of UserData ",content:`

public static string UserDataText { get; set; }

Default text representation of UserData

Value Type

Type	Description
String

`}),e.add({id:3280,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default UserData content ",content:`

public string UserDataText

Default UserData content

Value Type

Type	Description
String

`}),e.add({id:3281,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default text representation of UserData ",content:`

public static string UserDataText { get; set; }

Default text representation of UserData

Value Type

Type	Description
String

`}),e.add({id:3282,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default text representation of UserData ",content:`

public static string UserDataText { get; set; }

Default text representation of UserData

Value Type

Type	Description
String

`}),e.add({id:3283,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/userdatatext/",title:"UserDataText",section:"ODIN Documentation",description:" Default UserData content ",content:`

public string UserDataText

Default UserData content

Value Type

Type	Description
String

`}),e.add({id:3284,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinpeerjoinedeventpayload/userid/",title:"userId",section:"ODIN Documentation",description:"The ID of the user that joined.",content:`

public userId: string

The ID of the user that joined.

`}),e.add({id:3285,href:"https://www.4players.io/odin/sdk/web/classes/odinpeer/userid/",title:"userId",section:"ODIN Documentation",description:"The identifier of the peer.",content:`

string

The identifier of the peer.

`}),e.add({id:3286,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peer/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3287,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:" user Id ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public string UserId { get; }

user Id

Value Type

Type	Description
String

`}),e.add({id:3288,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peer/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3289,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:" user Id ",content:`

public string UserId { get; }

user Id

Value Type

Type	Description
String

`}),e.add({id:3290,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peer/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3291,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:" user Id ",content:`

public string UserId { get; }

user Id

Value Type

Type	Description
String

`}),e.add({id:3292,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peer/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3293,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:" user Id ",content:`

public string UserId { get; }

user Id

Value Type

Type	Description
String

`}),e.add({id:3294,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinpeer/userid/",title:"UserId",section:"ODIN Documentation",description:"",content:`

public string UserId { get; }

Value Type

Type	Description
String

`}),e.add({id:3295,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerentity/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3296,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:"",content:`

public string UserId

Value Type

Type	Description
String

`}),e.add({id:3297,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/peerrpc/userid/",title:"UserId",section:"ODIN Documentation",description:" token user id ",content:`

public string UserId

token user id

Value Type

Type	Description
String

`}),e.add({id:3298,href:"https://www.4players.io/odin/sdk/unity/classes/peer/userid/",title:"UserId",section:"ODIN Documentation",description:" Peers user id ",content:`

public string UserId { get; }

Peers user id

Value Type

Type	Description
String

`}),e.add({id:3299,href:"https://www.4players.io/odin/sdk/unity/classes/peerjoinedeventargs/userid/",title:"UserId",section:"ODIN Documentation",description:" user Id ",content:`

public string UserId { get; }

user Id

Value Type

Type	Description
String

`}),e.add({id:3300,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static class Utility

Properties

Name	Type	Description
OK	UInt32	Representative ErrorCode for Ok.

Static Methods

Name	Description
RateToSamples	Get sample size by samplerate and time
IsError	Determines if the specified error code identifies an actual error.

`}),e.add({id:3301,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

public static class Utility

Properties

Name	Type	Description
OK	UInt32	Representative ErrorCode for Ok.

Static Methods

Name	Description
RateToSamples	Get sample size by samplerate and time
IsError	Determines if the specified error code identifies an actual error.

`}),e.add({id:3302,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

public static class Utility

Properties

Name	Type	Description
OK	UInt32	Representative ErrorCode for Ok.

Static Methods

Name	Description
RateToSamples	Get sample size by samplerate and time
IsError	Determines if the specified error code identifies an actual error.

`}),e.add({id:3303,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

public static class Utility

Static Methods

Name	Description
RateToSamples	Get sample size by samplerate and time
IsError	Determines if the specified error code identifies an actual error.

Properties

Name	Description
OK	Representative ErrorCode for Ok.

`}),e.add({id:3304,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

public static class Utility

Static Methods

Name	Description
GetNativeBuffer	Get Odin native buffer IntPtr data
Test
IsOk	Checks the return code for errors
OdinErrorToString	Retrieves the name of the constant in the specified NativeBindings
RateToSamples	Get sample size by samplerate and time

Properties

Name	Description
MIN_DBFS

`}),e.add({id:3305,href:"https://www.4players.io/odin/sdk/unity/classes/utility/",title:"Utility",section:"ODIN Documentation",description:" ",content:`

public static class Utility

Static Methods

Name	Description
RateToSamples	Get sample size by samplerate and time
IsError	Determines if the specified error code identifies an actual error.

Properties

Name	Description
OK	Representative ErrorCode for Ok.

`}),e.add({id:3306,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/",title:"VadEffect",section:"ODIN Documentation",description:" VoiceActivity effect for ",content:`

Inherits from: PiplineEffect

public class VadEffect : PiplineEffect, IPiplineEffect

VoiceActivity effect for Odin

Constructors

Name	Description
VadEffect(OdinPipelineHandle, UInt32)	Internal effect constructor, use Odin

Static Methods

Name	Description
Create	Insert a vad effect in the specified pipline

Properties

Name	Description
Config	Intern voice activity configuration
VoiceActivityEnabled	Idicates whether the vad setting in NativeBindings is enabled
VoiceActivityAttackThreshold	Idicates the vad attack probability setting in NativeBindings
VoiceActivityReleaseThreshold	Idicates the vad release probability setting in NativeBindings
VolumeGateEnabled	Idicates whether the gate setting in NativeBindings is enabled
VolumeGateAttackThreshold	Idicates the gate attack loudness setting in NativeBindings
VolumeGateReleaseThreshold	Idicates the gate release loudness setting in NativeBindings

Public Methods

Name	Description
UpdateEffectConfig	Set voice activity configuration
SetVadConfig	Set managed voice activity configuration
GetVadConfig	Get native voice activity configuration
SetApmConfig	Not supported
SetApmStreamDelay	Not supported
UpdateApmPlayback	Not supported

Inherited Properties

Name	Description
Id	Effect id
Index	Effect index
Parent	Pipeline handle

Inherited Methods

Name	Description
GetEffectIndex	Get native effect index
GetEffectType	Get native effect NativeBindings
GetVadConfig	Get native voice activity config
SetApmConfig	Set native audio processing config
SetApmStreamDelay	Set native audio processing delay
SetVadConfig	Set native voice activity config
UpdateApmPlayback	Send samples for native audio processing

`}),e.add({id:3307,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/constructor_0/",title:"VadEffect(OdinPipelineHandle, UInt32)",section:"ODIN Documentation",description:"",content:`

protected VadEffect(OdinPipelineHandle parentHandle, uint effectId)

Internal effect constructor, use Odin

Parameters

Name	Description
parentHandle	pipeline handle
effectId	effect id

`}),e.add({id:3308,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/rpcresult/value/",title:"Value",section:"ODIN Documentation",description:" result ",content:`

public object Value { get; }

result

Value Type

Type	Description
Object

`}),e.add({id:3309,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3310,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool Verbose

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3311,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3312,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool Verbose

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3313,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3314,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool Verbose

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3315,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3316,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool Verbose

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3317,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3318,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional logs ",content:`

public static bool Verbose

Enable additional logs

Value Type

Type	Description
Boolean

`}),e.add({id:3319,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/verbose/",title:"Verbose",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool Verbose

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3320,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/verbosedebug/",title:"VerboseDebug",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool VerboseDebug

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3321,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/verbosedebug/",title:"VerboseDebug",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool VerboseDebug

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3322,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/verbosedebug/",title:"VerboseDebug",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool VerboseDebug

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3323,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/verbosedebug/",title:"VerboseDebug",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool VerboseDebug

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3324,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/verbosedebug/",title:"VerboseDebug",section:"ODIN Documentation",description:" Enable additional Logs ",content:`

public bool VerboseDebug

Enable additional Logs

Value Type

Type	Description
Boolean

`}),e.add({id:3325,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/odinnoisesuppressionlevel/veryhigh/",title:"VeryHigh",section:"ODIN Documentation",description:" 21 dB ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

VeryHigh = 4

21 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:3326,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/odinnoisesuppressionlevel/veryhigh/",title:"VeryHigh",section:"ODIN Documentation",description:" 21 dB ",content:`

VeryHigh = 4

21 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:3327,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/odinnoisesuppressionlevel/veryhigh/",title:"VeryHigh",section:"ODIN Documentation",description:" 21 dB ",content:`

VeryHigh = 4

21 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:3328,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/odinnoisesuppressionlevel/veryhigh/",title:"VeryHigh",section:"ODIN Documentation",description:" 21 dB ",content:`

VeryHigh = 4

21 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:3329,href:"https://www.4players.io/odin/sdk/unity/enums/odinnoisesuppressionlevel/veryhigh/",title:"VeryHigh",section:"ODIN Documentation",description:" 21 dB ",content:`

VeryHigh = 4

21 dB

Value Type

Type	Description
OdinNoiseSuppressionLevel

`}),e.add({id:3330,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinvadconfig/voice_activity/",title:"voice_activity",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinSensitivityConfig voice_activity

Value Type

Type	Description
OdinSensitivityConfig

`}),e.add({id:3331,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/voiceactivityattackthreshold/",title:"VoiceActivityAttackThreshold",section:"ODIN Documentation",description:" Idicates the vad attack probability setting in ",content:`

public float VoiceActivityAttackThreshold

Idicates the vad attack probability setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3332,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/voiceactivityattackthreshold/",title:"VoiceActivityAttackThreshold",section:"ODIN Documentation",description:" Idicates the vad attack probability setting in ",content:`

public float VoiceActivityAttackThreshold { get; set; }

Idicates the vad attack probability setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3333,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/voiceactivitydetection/",title:"voiceActivityDetection",section:"ODIN Documentation",description:"Enables or disables voice activity detection (VAD)",content:`

public voiceActivityDetection: boolean

Enables or disables voice activity detection (VAD)

`}),e.add({id:3334,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/voiceactivitydetection/",title:"voiceActivityDetection",section:"ODIN Documentation",description:"Enable or disable RNN-based voice activity detection.",content:`

boolean

Enable or disable RNN-based voice activity detection.

`}),e.add({id:3335,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3336,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Turns VAD on and off ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool VoiceActivityDetection

Turns VAD on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3337,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Enables or disables voice activity detection (VAD) ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool VoiceActivityDetection { get; set; }

Enables or disables voice activity detection (VAD)

Value Type

Type	Description
Boolean

`}),e.add({id:3338,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3339,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Turns VAD on and off ",content:`

public bool VoiceActivityDetection

Turns VAD on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3340,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Enables or disables voice activity detection (VAD) ",content:`

public bool VoiceActivityDetection { get; set; }

Enables or disables voice activity detection (VAD)

Value Type

Type	Description
Boolean

`}),e.add({id:3341,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3342,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Turns VAD on and off ",content:`

public bool VoiceActivityDetection

Turns VAD on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3343,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Enables or disables voice activity detection (VAD) ",content:`

public bool VoiceActivityDetection { get; set; }

Enables or disables voice activity detection (VAD)

Value Type

Type	Description
Boolean

`}),e.add({id:3344,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3345,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Turns VAD on and off ",content:`

public bool VoiceActivityDetection

Turns VAD on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3346,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Enables or disables voice activity detection (VAD) ",content:`

public bool VoiceActivityDetection { get; set; }

Enables or disables voice activity detection (VAD)

Value Type

Type	Description
Boolean

`}),e.add({id:3347,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3348,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VoiceActivityDetection

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3349,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Turns VAD on and off ",content:`

public bool VoiceActivityDetection

Turns VAD on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3350,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/voiceactivitydetection/",title:"VoiceActivityDetection",section:"ODIN Documentation",description:" Enables or disables voice activity detection (VAD) ",content:`

public bool VoiceActivityDetection { get; set; }

Enables or disables voice activity detection (VAD)

Value Type

Type	Description
Boolean

`}),e.add({id:3351,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/voiceactivitydetectionattackprobability/",title:"voiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:"Voice probability value when the VAD should engage",content:`

public voiceActivityDetectionAttackProbability: number

Voice probability value when the VAD should engage

`}),e.add({id:3352,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/voiceactivitydetectionattackprobability/",title:"voiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:"Voice probability value when the VAD should engage",content:`

number

Voice probability value when the VAD should engage

`}),e.add({id:3353,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3354,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Setup engage of VAD ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VoiceActivityDetectionAttackProbability

Setup engage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3355,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should engage. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VoiceActivityDetectionAttackProbability { get; set; }

Voice probability value when the VAD should engage.

Value Type

Type	Description
Single

`}),e.add({id:3356,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3357,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Setup engage of VAD ",content:`

public float VoiceActivityDetectionAttackProbability

Setup engage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3358,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should engage. ",content:`

public float VoiceActivityDetectionAttackProbability { get; set; }

Voice probability value when the VAD should engage.

Value Type

Type	Description
Single

`}),e.add({id:3359,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3360,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Setup engage of VAD ",content:`

public float VoiceActivityDetectionAttackProbability

Setup engage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3361,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should engage. ",content:`

public float VoiceActivityDetectionAttackProbability { get; set; }

Voice probability value when the VAD should engage.

Value Type

Type	Description
Single

`}),e.add({id:3362,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3363,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Setup engage of VAD ",content:`

public float VoiceActivityDetectionAttackProbability

Setup engage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3364,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should engage. ",content:`

public float VoiceActivityDetectionAttackProbability { get; set; }

Voice probability value when the VAD should engage.

Value Type

Type	Description
Single

`}),e.add({id:3365,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3366,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Idicates the vad attack probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionAttackProbability

Idicates the vad attack probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3367,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Setup engage of VAD ",content:`

public float VoiceActivityDetectionAttackProbability

Setup engage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3368,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/voiceactivitydetectionattackprobability/",title:"VoiceActivityDetectionAttackProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should engage. ",content:`

public float VoiceActivityDetectionAttackProbability { get; set; }

Voice probability value when the VAD should engage.

Value Type

Type	Description
Single

`}),e.add({id:3369,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/voiceactivitydetectionreleaseprobability/",title:"voiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:"Voice probability value when the VAD should disengage",content:`

public voiceActivityDetectionReleaseProbability: number

Voice probability value when the VAD should disengage

`}),e.add({id:3370,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/voiceactivitydetectionreleaseprobability/",title:"voiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:"Voice probability value when the VAD should disengage",content:`

number

Voice probability value when the VAD should disengage

`}),e.add({id:3371,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3372,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Setup disengage of VAD ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VoiceActivityDetectionReleaseProbability

Setup disengage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3373,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should disengage after previously being engaged. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VoiceActivityDetectionReleaseProbability { get; set; }

Voice probability value when the VAD should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3374,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3375,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Setup disengage of VAD ",content:`

public float VoiceActivityDetectionReleaseProbability

Setup disengage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3376,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should disengage after previously being engaged. ",content:`

public float VoiceActivityDetectionReleaseProbability { get; set; }

Voice probability value when the VAD should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3377,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3378,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Setup disengage of VAD ",content:`

public float VoiceActivityDetectionReleaseProbability

Setup disengage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3379,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should disengage after previously being engaged. ",content:`

public float VoiceActivityDetectionReleaseProbability { get; set; }

Voice probability value when the VAD should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3380,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3381,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Setup disengage of VAD ",content:`

public float VoiceActivityDetectionReleaseProbability

Setup disengage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3382,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should disengage after previously being engaged. ",content:`

public float VoiceActivityDetectionReleaseProbability { get; set; }

Voice probability value when the VAD should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3383,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3384,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Idicates the vad release probability ApmConfig setting by default ",content:`

public static float VoiceActivityDetectionReleaseProbability

Idicates the vad release probability ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3385,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Setup disengage of VAD ",content:`

public float VoiceActivityDetectionReleaseProbability

Setup disengage of VAD

Value Type

Type	Description
Single

`}),e.add({id:3386,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/voiceactivitydetectionreleaseprobability/",title:"VoiceActivityDetectionReleaseProbability",section:"ODIN Documentation",description:" Voice probability value when the VAD should disengage after previously being engaged. ",content:`

public float VoiceActivityDetectionReleaseProbability { get; set; }

Voice probability value when the VAD should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3387,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/voiceactivityenabled/",title:"VoiceActivityEnabled",section:"ODIN Documentation",description:"",content:`

public bool VoiceActivityEnabled

Value Type

Type	Description
Boolean

`}),e.add({id:3388,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/voiceactivityenabled/",title:"VoiceActivityEnabled",section:"ODIN Documentation",description:" Idicates whether the vad setting in is enabled ",content:`

public bool VoiceActivityEnabled { get; set; }

Idicates whether the vad setting in NativeBindings is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:3389,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/voiceactivityreleasethreshold/",title:"VoiceActivityReleaseThreshold",section:"ODIN Documentation",description:" Idicates the vad release probability setting in ",content:`

public float VoiceActivityReleaseThreshold

Idicates the vad release probability setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3390,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/voiceactivityreleasethreshold/",title:"VoiceActivityReleaseThreshold",section:"ODIN Documentation",description:" Idicates the vad release probability setting in ",content:`

public float VoiceActivityReleaseThreshold { get; set; }

Idicates the vad release probability setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3391,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinroomevents/voiceprocessingstats/",title:"VoiceProcessingStats",section:"ODIN Documentation",description:"Internal RNN VAD stats updates.",content:`

OdinVoiceProcessingStatsEvent

Internal RNN VAD stats updates.

`}),e.add({id:3392,href:"https://www.4players.io/odin/sdk/web/classes/odinmedia/volume/",title:"volume",section:"ODIN Documentation",description:"The individual playback volume of the media stream.",content:`

number

The individual playback volume of the media stream.

`}),e.add({id:3393,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvolumecomponent/volume/",title:"Volume",section:"ODIN Documentation",description:"",content:`

public float Volume

Value Type

Type	Description
Single

`}),e.add({id:3394,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/odinvadconfig/volume_gate/",title:"volume_gate",section:"ODIN Documentation",description:"",content:`

public NativeBindings.OdinSensitivityConfig volume_gate

Value Type

Type	Description
OdinSensitivityConfig

`}),e.add({id:3395,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/volumegate/",title:"volumeGate",section:"ODIN Documentation",description:"Enables or disables the input volume gate",content:`

public volumeGate: boolean

Enables or disables the input volume gate

`}),e.add({id:3396,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/volumegate/",title:"volumeGate",section:"ODIN Documentation",description:"Enables or disables the input volume gate",content:`

boolean

Enables or disables the input volume gate

`}),e.add({id:3397,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3398,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Turns volume gate on and off ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool VolumeGate

Turns volume gate on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3399,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Enables or disables volume gate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public bool VolumeGate { get; set; }

Enables or disables volume gate

Value Type

Type	Description
Boolean

`}),e.add({id:3400,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3401,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Turns volume gate on and off ",content:`

public bool VolumeGate

Turns volume gate on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3402,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Enables or disables volume gate ",content:`

public bool VolumeGate { get; set; }

Enables or disables volume gate

Value Type

Type	Description
Boolean

`}),e.add({id:3403,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3404,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Turns volume gate on and off ",content:`

public bool VolumeGate

Turns volume gate on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3405,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Enables or disables volume gate ",content:`

public bool VolumeGate { get; set; }

Enables or disables volume gate

Value Type

Type	Description
Boolean

`}),e.add({id:3406,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3407,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Turns volume gate on and off ",content:`

public bool VolumeGate

Turns volume gate on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3408,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Enables or disables volume gate ",content:`

public bool VolumeGate { get; set; }

Enables or disables volume gate

Value Type

Type	Description
Boolean

`}),e.add({id:3409,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3410,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Idicates whether the ApmConfig setting is enabled by default ",content:`

public static bool VolumeGate

Idicates whether the ApmConfig setting is enabled by default

Value Type

Type	Description
Boolean

`}),e.add({id:3411,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Turns volume gate on and off ",content:`

public bool VolumeGate

Turns volume gate on and off

Value Type

Type	Description
Boolean

`}),e.add({id:3412,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/volumegate/",title:"VolumeGate",section:"ODIN Documentation",description:" Enables or disables volume gate ",content:`

public bool VolumeGate { get; set; }

Enables or disables volume gate

Value Type

Type	Description
Boolean

`}),e.add({id:3413,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/volumegateattackloudness/",title:"volumeGateAttackLoudness",section:"ODIN Documentation",description:"Root-mean-square power (dBFS) when the volume gate should engage",content:`

public volumeGateAttackLoudness: number

Root-mean-square power (dBFS) when the volume gate should engage

`}),e.add({id:3414,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/volumegateattackloudness/",title:"volumeGateAttackLoudness",section:"ODIN Documentation",description:"Root mean square power (dBFS) when the volume gate should engage",content:`

number

Root mean square power (dBFS) when the volume gate should engage

`}),e.add({id:3415,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3416,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Setup engage of volume gate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VolumeGateAttackLoudness

Setup engage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3417,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should engage. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VolumeGateAttackLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should engage.

Value Type

Type	Description
Single

`}),e.add({id:3418,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3419,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Setup engage of volume gate ",content:`

public float VolumeGateAttackLoudness

Setup engage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3420,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should engage. ",content:`

public float VolumeGateAttackLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should engage.

Value Type

Type	Description
Single

`}),e.add({id:3421,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3422,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Setup engage of volume gate ",content:`

public float VolumeGateAttackLoudness

Setup engage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3423,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should engage. ",content:`

public float VolumeGateAttackLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should engage.

Value Type

Type	Description
Single

`}),e.add({id:3424,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3425,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Setup engage of volume gate ",content:`

public float VolumeGateAttackLoudness

Setup engage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3426,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should engage. ",content:`

public float VolumeGateAttackLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should engage.

Value Type

Type	Description
Single

`}),e.add({id:3427,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3428,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Idicates the gate attack loudness ApmConfig setting by default ",content:`

public static float VolumeGateAttackLoudness

Idicates the gate attack loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3429,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Setup engage of volume gate ",content:`

public float VolumeGateAttackLoudness

Setup engage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3430,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/volumegateattackloudness/",title:"VolumeGateAttackLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should engage. ",content:`

public float VolumeGateAttackLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should engage.

Value Type

Type	Description
Single

`}),e.add({id:3431,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/volumegateattackthreshold/",title:"VolumeGateAttackThreshold",section:"ODIN Documentation",description:" Idicates the gate attack loudness setting in ",content:`

public float VolumeGateAttackThreshold

Idicates the gate attack loudness setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3432,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/volumegateattackthreshold/",title:"VolumeGateAttackThreshold",section:"ODIN Documentation",description:" Idicates the gate attack loudness setting in ",content:`

public float VolumeGateAttackThreshold { get; set; }

Idicates the gate attack loudness setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3433,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/volumegateenabled/",title:"VolumeGateEnabled",section:"ODIN Documentation",description:"",content:`

public bool VolumeGateEnabled

Value Type

Type	Description
Boolean

`}),e.add({id:3434,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/volumegateenabled/",title:"VolumeGateEnabled",section:"ODIN Documentation",description:" Idicates whether the gate setting in is enabled ",content:`

public bool VolumeGateEnabled { get; set; }

Idicates whether the gate setting in NativeBindings is enabled

Value Type

Type	Description
Boolean

`}),e.add({id:3435,href:"https://www.4players.io/odin/sdk/nodejs/interfaces/odinapmsettings/volumegatereleaseloudness/",title:"volumeGateReleaseLoudness",section:"ODIN Documentation",description:"Root-mean-square power (dBFS) when the volume gate should disengage",content:`

public volumeGateReleaseLoudness: number

Root-mean-square power (dBFS) when the volume gate should disengage

`}),e.add({id:3436,href:"https://www.4players.io/odin/sdk/web/interfaces/iodinaudiosettings/volumegatereleaseloudness/",title:"volumeGateReleaseLoudness",section:"ODIN Documentation",description:"Root mean square power (dBFS) when the volume gate should disengage",content:`

number

Root mean square power (dBFS) when the volume gate should disengage

`}),e.add({id:3437,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3438,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odineditorconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Setup disengage of volume gate ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VolumeGateReleaseLoudness

Setup disengage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3439,href:"https://www.4players.io/odin/sdk/unity/1.1.0/classes/odinroomconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should disengage after previously being engaged. ",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

public float VolumeGateReleaseLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3440,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3441,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odineditorconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Setup disengage of volume gate ",content:`

public float VolumeGateReleaseLoudness

Setup disengage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3442,href:"https://www.4players.io/odin/sdk/unity/1.5.8/classes/odinroomconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should disengage after previously being engaged. ",content:`

public float VolumeGateReleaseLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3443,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3444,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odineditorconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Setup disengage of volume gate ",content:`

public float VolumeGateReleaseLoudness

Setup disengage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3445,href:"https://www.4players.io/odin/sdk/unity/1.6.0/classes/odinroomconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should disengage after previously being engaged. ",content:`

public float VolumeGateReleaseLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3446,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3447,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odineditorconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Setup disengage of volume gate ",content:`

public float VolumeGateReleaseLoudness

Setup disengage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3448,href:"https://www.4players.io/odin/sdk/unity/1.6.6/classes/odinroomconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should disengage after previously being engaged. ",content:`

public float VolumeGateReleaseLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3449,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3450,href:"https://www.4players.io/odin/sdk/unity/classes/odindefaults/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Idicates the gate release loudness ApmConfig setting by default ",content:`

public static float VolumeGateReleaseLoudness

Idicates the gate release loudness ApmConfig setting by default

Value Type

Type	Description
Single

`}),e.add({id:3451,href:"https://www.4players.io/odin/sdk/unity/classes/odineditorconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Setup disengage of volume gate ",content:`

public float VolumeGateReleaseLoudness

Setup disengage of volume gate

Value Type

Type	Description
Single

`}),e.add({id:3452,href:"https://www.4players.io/odin/sdk/unity/classes/odinroomconfig/volumegatereleaseloudness/",title:"VolumeGateReleaseLoudness",section:"ODIN Documentation",description:" Root mean square power (dBFS) when the volume gate should disengage after previously being engaged. ",content:`

public float VolumeGateReleaseLoudness { get; set; }

Root mean square power (dBFS) when the volume gate should disengage after previously being engaged.

Value Type

Type	Description
Single

`}),e.add({id:3453,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinvadcomponent/volumegatereleasethreshold/",title:"VolumeGateReleaseThreshold",section:"ODIN Documentation",description:" Idicates the gate release loudness setting in ",content:`

public float VolumeGateReleaseThreshold

Idicates the gate release loudness setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3454,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/vadeffect/volumegatereleasethreshold/",title:"VolumeGateReleaseThreshold",section:"ODIN Documentation",description:" Idicates the gate release loudness setting in ",content:`

public float VolumeGateReleaseThreshold { get; set; }

Idicates the gate release loudness setting in NativeBindings

Value Type

Type	Description
Single

`}),e.add({id:3455,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/odinroom/webrequesttoken/",title:"WebRequestToken",section:"ODIN Documentation",description:"",content:`

public IEnumerator WebRequestToken(string url, string jsonPayload)
public IEnumerator WebRequestToken(string url, string jsonPayload, UnityAction<DownloadHandler> response)

Uses UnityWebRequest with POST data as json to get a response from a token-server

Info

Default callback will set OdinRoom with the response plain text

Parameters

Name	Type	Description
url	String	Token-Server endpoint
jsonPayload	String	Request data
response	UnityAction<DownloadHandler>	Response callback

Returns

Type	Description
IEnumerator	IEnumerator for Coroutine

Variants

WebRequestToken(url, jsonPayload)

public IEnumerator WebRequestToken(string url, string jsonPayload)

Uses UnityWebRequest with POST data as json to get a response from a token-server

Warning

Default callback will set OdinRoom with the response plain text

Parameters

Name	Type	Description
url	String	Token-Server endpoint
jsonPayload	String	Request data

Returns

Type	Description
IEnumerator	IEnumerator for Coroutine

WebRequestToken(url, jsonPayload, response)

public IEnumerator WebRequestToken(string url, string jsonPayload, UnityAction<DownloadHandler> response)

Uses UnityWebRequest with POST data as json to get a response from a token-server

Parameters

Name	Type	Description
url	String	Token-Server endpoint
jsonPayload	String	Request data
response	UnityAction<DownloadHandler>	Response callback

Returns

Type	Description
IEnumerator	IEnumerator for Coroutine

`}),e.add({id:3456,href:"https://www.4players.io/odin/sdk/unity/1.1.0/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Warning

Version 1.1.0 is deprecated and will be removed in the future and is not being supported for new users. Please update to the latest version as soon as possible.

Windows = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3457,href:"https://www.4players.io/odin/sdk/unity/1.5.8/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Windows = 4

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3458,href:"https://www.4players.io/odin/sdk/unity/1.6.0/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Windows = 3

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3459,href:"https://www.4players.io/odin/sdk/unity/1.6.6/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Windows = 4

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3460,href:"https://www.4players.io/odin/sdk/unity/2.0.0/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Windows = 4

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3461,href:"https://www.4players.io/odin/sdk/unity/enums/supportedplatform/windows/",title:"Windows",section:"ODIN Documentation",description:"",content:`

Windows = 4

Value Type

Type	Description
SupportedPlatform

`}),e.add({id:3462,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/write/",title:"Write",section:"ODIN Documentation",description:"",content:`

public int Write(uint value)
public int Write(int value)

Set MsgPackToken based on the unsigend value size

Parameters

Name	Type	Description
value	UInt32	value to write and identify size
value	Int32	value to write and identify size

Returns

Type	Description
Int32	size written

Variants

Write(value)

public int Write(uint value)

Set MsgPackToken based on the unsigend value size

Parameters

Name	Type	Description
value	UInt32	value to write and identify size

Returns

Type	Description
Int32	size written

Write(value)

public int Write(int value)

Set MsgPackToken based on the sigend value size

Parameters

Name	Type	Description
value	Int32	value to write and identify size

Returns

Type	Description
Int32	size written

`}),e.add({id:3463,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/write/",title:"Write",section:"ODIN Documentation",description:"",content:`

int Write(int value)
int Write(uint value)

Parameters

Name	Type	Description
value	Int32
value	UInt32

Returns

Type	Description
Int32

Variants

Write(value)

int Write(int value)

Parameters

Name	Type	Description
value	Int32

Returns

Type	Description
Int32

Write(value)

int Write(uint value)

Parameters

Name	Type	Description
value	UInt32

Returns

Type	Description
Int32

`}),e.add({id:3464,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writearrayheader/",title:"WriteArrayHeader",section:"ODIN Documentation",description:"",content:`

public int WriteArrayHeader(uint count)

MessagePack header is big-endian, value binarywriter default little-endian

Parameters

Name	Type	Description
count	UInt32

Returns

Type	Description
Int32

`}),e.add({id:3465,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writearrayheader/",title:"WriteArrayHeader",section:"ODIN Documentation",description:"",content:`

int WriteArrayHeader(uint count)

Parameters

Name	Type	Description
count	UInt32

Returns

Type	Description
Int32

`}),e.add({id:3466,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writebinary/",title:"WriteBinary",section:"ODIN Documentation",description:"",content:`

public static int WriteBinary(ref List<byte> bytes, byte[] value)

Append values with size based token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Byte[]

Returns

Type	Description
Int32

`}),e.add({id:3467,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writebinary/",title:"WriteBinary",section:"ODIN Documentation",description:"",content:`

int WriteBinary(byte[] value)

Parameters

Name	Type	Description
value	Byte[]

Returns

Type	Description
Int32

`}),e.add({id:3468,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writebool/",title:"WriteBool",section:"ODIN Documentation",description:"",content:`

public static void WriteBool(ref List<byte> bytes, bool value)

Append fixedbool with either MsgPackToken to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Boolean

`}),e.add({id:3469,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writebool/",title:"WriteBool",section:"ODIN Documentation",description:"",content:`

void WriteBool(bool value)

Parameters

Name	Type	Description
value	Boolean

`}),e.add({id:3470,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writebyte/",title:"WriteByte",section:"ODIN Documentation",description:"",content:`

public static void WriteByte(ref List<byte> bytes, byte value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Byte

`}),e.add({id:3471,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writebyte/",title:"WriteByte",section:"ODIN Documentation",description:"",content:`

void WriteByte(byte value)

Parameters

Name	Type	Description
value	Byte

`}),e.add({id:3472,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writedouble/",title:"WriteDouble",section:"ODIN Documentation",description:"",content:`

public static void WriteDouble(ref List<byte> bytes, double value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Double

`}),e.add({id:3473,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writedouble/",title:"WriteDouble",section:"ODIN Documentation",description:"",content:`

void WriteDouble(double value)

Parameters

Name	Type	Description
value	Double

`}),e.add({id:3474,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writefloat/",title:"WriteFloat",section:"ODIN Documentation",description:"",content:`

public static void WriteFloat(ref List<byte> bytes, float value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Single

`}),e.add({id:3475,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writefloat/",title:"WriteFloat",section:"ODIN Documentation",description:"",content:`

void WriteFloat(float value)

Parameters

Name	Type	Description
value	Single

`}),e.add({id:3476,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writeint/",title:"WriteInt",section:"ODIN Documentation",description:"",content:`

public static void WriteInt(ref List<byte> bytes, int value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Int32

`}),e.add({id:3477,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writeint/",title:"WriteInt",section:"ODIN Documentation",description:"",content:`

void WriteInt(int value)

Parameters

Name	Type	Description
value	Int32

`}),e.add({id:3478,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writelong/",title:"WriteLong",section:"ODIN Documentation",description:"",content:`

public static void WriteLong(ref List<byte> bytes, long value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Int64

`}),e.add({id:3479,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writelong/",title:"WriteLong",section:"ODIN Documentation",description:"",content:`

void WriteLong(long value)

Parameters

Name	Type	Description
value	Int64

`}),e.add({id:3480,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writemapheader/",title:"WriteMapHeader",section:"ODIN Documentation",description:"",content:`

public int WriteMapHeader(uint count)

MessagePack header is big-endian value binarywriter default little-endian

Parameters

Name	Type	Description
count	UInt32

Returns

Type	Description
Int32

`}),e.add({id:3481,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writemapheader/",title:"WriteMapHeader",section:"ODIN Documentation",description:"",content:`

int WriteMapHeader(uint count)

Parameters

Name	Type	Description
count	UInt32

Returns

Type	Description
Int32

`}),e.add({id:3482,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writesbyte/",title:"WriteSByte",section:"ODIN Documentation",description:"",content:`

public static void WriteSByte(ref List<byte> bytes, sbyte value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	SByte

`}),e.add({id:3483,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writesbyte/",title:"WriteSByte",section:"ODIN Documentation",description:"",content:`

void WriteSByte(sbyte value)

Parameters

Name	Type	Description
value	SByte

`}),e.add({id:3484,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writeshort/",title:"WriteShort",section:"ODIN Documentation",description:"",content:`

public static void WriteShort(ref List<byte> bytes, short value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	Int16

`}),e.add({id:3485,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writeshort/",title:"WriteShort",section:"ODIN Documentation",description:"",content:`

void WriteShort(short value)

Parameters

Name	Type	Description
value	Int16

`}),e.add({id:3486,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writestring/",title:"WriteString",section:"ODIN Documentation",description:"",content:`

public static int WriteString(ref List<byte> bytes, string value, Encoding encoding)

Append string value with size based token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	String
encoding	Encoding

Returns

Type	Description
Int32	size written

`}),e.add({id:3487,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writestring/",title:"WriteString",section:"ODIN Documentation",description:"",content:`

int WriteString(string value)
int WriteString(string value, Encoding encoding)

Parameters

Name	Type	Description
value	String
encoding	Encoding

Returns

Type	Description
Int32

Variants

WriteString(value)

int WriteString(string value)

Parameters

Name	Type	Description
value	String

Returns

Type	Description
Int32

WriteString(value, encoding)

int WriteString(string value, Encoding encoding)

Parameters

Name	Type	Description
value	String
encoding	Encoding

Returns

Type	Description
Int32

`}),e.add({id:3488,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writeuint/",title:"WriteUInt",section:"ODIN Documentation",description:"",content:`

public static void WriteUInt(ref List<byte> bytes, uint value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	UInt32

`}),e.add({id:3489,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writeuint/",title:"WriteUInt",section:"ODIN Documentation",description:"",content:`

void WriteUInt(uint value)

Parameters

Name	Type	Description
value	UInt32

`}),e.add({id:3490,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writeulong/",title:"WriteULong",section:"ODIN Documentation",description:"",content:`

public static void WriteULong(ref List<byte> bytes, ulong value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	UInt64

`}),e.add({id:3491,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writeulong/",title:"WriteULong",section:"ODIN Documentation",description:"",content:`

void WriteULong(ulong value)

Parameters

Name	Type	Description
value	UInt64

`}),e.add({id:3492,href:"https://www.4players.io/odin/sdk/unity/2.0.0/classes/msgpackwriter/writeushort/",title:"WriteUShort",section:"ODIN Documentation",description:"",content:`

public static void WriteUShort(ref List<byte> bytes, ushort value)

Append value with MsgPackToken token to bytes

Parameters

Name	Type	Description
bytes	List<Byte>
value	UInt16

`}),e.add({id:3493,href:"https://www.4players.io/odin/sdk/unity/2.0.0/interfaces/imsgpackwriter/writeushort/",title:"WriteUShort",section:"ODIN Documentation",description:"",content:`

void WriteUShort(ushort value)

Parameters

Name	Type	Description
value	UInt16

`}),e.add({id:3494,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/x/",title:"X",section:"ODIN Documentation",description:" relative position to alphamap width ",content:`

public float X

relative position to alphamap width

Value Type

Type	Description
Single

`}),e.add({id:3495,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/y/",title:"Y",section:"ODIN Documentation",description:" relative position to alphamap layers ",content:`

public float Y

relative position to alphamap layers

Value Type

Type	Description
Single

`}),e.add({id:3496,href:"https://www.4players.io/odin/sdk/unity/2.0.0/structs/terrainfilteruserdata/z/",title:"Z",section:"ODIN Documentation",description:" relative position to alphamap height ",content:`

public float Z

relative position to alphamap height

Value Type

Type	Description
Single

`}),e.add({id:3497,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/odineditorconfig/",title:"Odin Editor Config",section:"ODIN Documentation",description:"This Unity Component handles ODIN setup within the Unity editor.",content:`

Client Authentication

Properties

Property	Description
Access Key	The access key that shall be used to generate access tokens for individual users. Read here on how to generate it.
Gateway URL	The base URL of the gateway. If you are using our hosted solution, leave it as is, otherwise if you are hosting yourself you need to adjust the URL
Manage Access	You can generate an access token for testing purposes right in the Unity editor for up to 25 users by pressing this button. See below for more details.
Client ID	The client id of your application. Use the Player Settings of Unity to set this value
User Data	This is the default user data that will be used for each player (if nothing is provided by you when joining the room)

More info on the user data can be found in the user data guide. A sample of what you can do with user data can be found in one of our integration guides.

Create access token

Warning

Capture & Playback

Use this section to setup your audio settings.

Properties

Property	Description
Capture Sample Rate	The sample rate that will be captured from the players MicrophoneReader
Capture Channels	Choose if MicrophoneReader should capture `Mono` or `Stereo` channels. In most cases, `Mono` is enough.
Playback Sample Rate	The sample rate that the server will use. If it does not match to the players sample rate the server will downgrade accordingly
Playback Channels	Choose if the server handles `Mono` or `Stereo` samples

Room Settings

Event Listeners

Warning

From Unity SDK version 0.5.0 the event handler settings have been moved to the Odin Handler class.

ODIN Handler

Let’s have a look at the settings exposed by the next component of a typical ODIN Manager Game Object: Odin Handler .

`}),e.add({id:3498,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/odineditorconfig/",title:"Odin Editor Config",section:"ODIN Documentation",description:"This Unity Component handles ODIN setup within the Unity editor.",content:`

Client Authentication

Properties

Property	Description
Access Key	The access key that shall be used to generate access tokens for individual users. Read here on how to generate it.
Gateway URL	The base URL of the gateway. If you are using our hosted solution, leave it as is, otherwise if you are hosting yourself you need to adjust the URL
Manage Access	You can generate an access token for testing purposes right in the Unity editor for up to 25 users by pressing this button. See below for more details.
Client ID	The client id of your application. Use the Player Settings of Unity to set this value
User Data	This is the default user data that will be used for each player (if nothing is provided by you when joining the room)

More info on the user data can be found in the user data guide. A sample of what you can do with user data can be found in one of our integration guides.

Create access token

Warning

Capture & Playback

Use this section to setup your audio settings.

Properties

Property	Description
Capture Sample Rate	The sample rate that will be captured from the players MicrophoneReader
Capture Channels	Choose if MicrophoneReader should capture `Mono` or `Stereo` channels. In most cases, `Mono` is enough.
Playback Sample Rate	The sample rate that the server will use. If it does not match to the players sample rate the server will downgrade accordingly
Playback Channels	Choose if the server handles `Mono` or `Stereo` samples

Room Settings

Event Listeners

Warning

From Unity SDK version 0.5.0 the event handler settings have been moved to the Odin Handler class.

ODIN Handler

Let’s have a look at the settings exposed by the next component of a typical ODIN Manager Game Object: Odin Handler .

`}),e.add({id:3499,href:"https://www.4players.io/odin/sdk/unity/manual/odineditorconfig/",title:"Odin Editor Config",section:"ODIN Documentation",description:"This Unity Component handles ODIN setup within the Unity editor.",content:`

Client Authentication

Properties

Property	Description
Access Key	The access key that shall be used to generate access tokens for individual users. Read here on how to generate it.
Gateway URL	The base URL of the gateway. If you are using our hosted solution, leave it as is, otherwise if you are hosting yourself you need to adjust the URL
Manage Access	You can generate an access token for testing purposes right in the Unity editor for up to 25 users by pressing this button. See below for more details.
Client ID	The client id of your application. Use the Player Settings of Unity to set this value
User Data	This is the default user data that will be used for each player (if nothing is provided by you when joining the room)

More info on the user data can be found in the user data guide. A sample of what you can do with user data can be found in one of our integration guides.

Create access token

Warning

Capture & Playback

Use this section to setup your audio settings.

Properties

Property	Description
Capture Sample Rate	The sample rate that will be captured from the players MicrophoneReader
Capture Channels	Choose if MicrophoneReader should capture `Mono` or `Stereo` channels. In most cases, `Mono` is enough.
Playback Sample Rate	The sample rate that the server will use. If it does not match to the players sample rate the server will downgrade accordingly
Playback Channels	Choose if the server handles `Mono` or `Stereo` samples

Room Settings

Event Listeners

Warning

From Unity SDK version 0.5.0 the event handler settings have been moved to the Odin Handler class.

ODIN Handler

Let’s have a look at the settings exposed by the next component of a typical ODIN Manager Game Object: Odin Handler .

`}),e.add({id:3500,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/odinhandler/",title:"Odin Handler",section:"ODIN Documentation",description:"This Unity Component handles ODIN events and other core parts",content:`

The OdinHandler component class is the global manager (singleton) for Odin inside your game. You can use it to connect your own callbacks.

Info

ODIN uses DontDestroyOnLoad in this class to make sure that this component and game object survives scene changes.

Microphone

The first option provided in the Odin Handler Inspector is the microphone setting:

Warning

Mixer Settings

Another set of options is playback mixer settings.

Sometimes you want to apply some audio effects to voice, like cell broadcast interferences or noise. Create a Unity AudioMixerGroup or AudioMixer and assign it to one of these options.

Setting	Description
Playback Mixer	Create a Unity AudioMixer asset and drag it into this field.
Playback Mixer Group	Create a Unity AudioMixerGroup asset and drag it into this field.

Playback Creation

Info

Please note: You should only select one of these checkboxes. We’ll change that to a drop down field in the next version of the SDK.

Playback auto creation

If you check this box, the ODIN SDK will automatically create an AudioSource and link that to the ODIN server for you and will handle the lifetime for you.

In addition to that, and that distinguishes this setting to Manual Positional Audio is that the PlaybackComponent will be automatically attached to the GameObject with the OdinHandler attached.

This is the easiest way to implement a simple “video conferencing” like use case where you don’t have positional audio or specific teams.

Info

Manual Positional Audio

If you check this box (and uncheck the other setting) ODIN will automatically create an AudioSource for you and link that to the ODIN server and handles the lifetime of it.

However, you are responsible to attach the PlaybackComponent to a GameObject representing the player (in space) and thus allowing you to implement 3D audio with ease.

Check out these guides on how to get notified of the SDK once an audio stream has been prepared and how to handle the event:

Getting Started with Unity: Create a simple Unity project and add ODIN to it. Shows the basic workflow and basic event handling.
Unity with Mirror Networking: Shows how to implement ODIN into a multiplayer game built with mirror networking. Create a simple multi-player game and add ODIN to it in under 20 minutes.

What you basically have to do is to listen on the OnCreatedMediaObject and OnDeleteMediaObject events of the OdinHandler instance like this:

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(OnDeleteMediaObject);
}

Here is a simple example on how to handle the event. More examples can be found in the reference documentation of PlaybackComponent , the OnMediaAdded event and the guides linked above.

private void OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Create or find a player object in the scene
    var peerContainer = CreateOrFindGameObject(peerId, roomName);

    // Create PlaybackComponent and add to the players GameObject
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Set spatialBlend to 1.0f to activate fill 3D audio and adjust some 3D audio settings
    // This is basic Unity stuff. PlaybackSource is an AudioSource object. See Unity documentation for more info 
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

Events

Read more about the events available in our Scripting documentation:

Room events

Event Type	Description
Room Join	Called before a player joins a room: OnRoomJoin
Room Joined	Called after a player joined a room: OnRoomJoined
Room Leave	Called before a player leaves a room: OnRoomLeave
Room Left	Called after a player left a room: OnRoomLeft

Peer events

Property	Description
Peer Joined	Called when another player joined the room: OnPeerJoined
Peer Left	Called when another player left the room: OnPeerLeft
Peer Updated	When the user data of a peer changes, this callback is called: OnPeerUserDataChanged

Warning

If the other player disables his microphone, a Media Removed event is triggered and all other peers will stop listening on this audio source.

Media events

When media streams are added or removed, you’ll receive these events.

Property	Description
Media Added	Called when the microphone stream of another user is joining the room: OnMediaAdded
Media State Changed	Called when the medias state changed: `OnMediaActiveStateChanged`
Media Removed	When one of the peers removes his microphone stream of the room, this callback is triggered: OnMediaRemoved

Microphone Reader settings

In a typical ODIN Manager Game Object a Microphone Reader component is attached which handles the players microphone and audio input. Let’s dig through these settings here: Microphone Reader .

`}),e.add({id:3501,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/odinhandler/",title:"Odin Handler",section:"ODIN Documentation",description:"This Unity Component handles ODIN events and other core parts",content:`

The OdinHandler component class is the global manager (singleton) for Odin inside your game. You can use it to connect your own callbacks.

Info

ODIN uses DontDestroyOnLoad in this class to make sure that this component and game object survives scene changes.

Microphone

The first option provided in the Odin Handler Inspector is the microphone setting:

Warning

Mixer Settings

Another set of options is playback mixer settings.

Sometimes you want to apply some audio effects to voice, like cell broadcast interferences or noise. Create a Unity AudioMixerGroup or AudioMixer and assign it to one of these options.

Setting	Description
Playback Mixer	Create a Unity AudioMixer asset and drag it into this field.
Playback Mixer Group	Create a Unity AudioMixerGroup asset and drag it into this field.

Playback Creation

Info

Please note: You should only select one of these checkboxes. We’ll change that to a drop down field in the next version of the SDK.

Playback auto creation

If you check this box, the ODIN SDK will automatically create an AudioSource and link that to the ODIN server for you and will handle the lifetime for you.

In addition to that, and that distinguishes this setting to Manual Positional Audio is that the PlaybackComponent will be automatically attached to the GameObject with the OdinHandler attached.

This is the easiest way to implement a simple “video conferencing” like use case where you don’t have positional audio or specific teams.

Info

Manual Positional Audio

If you check this box (and uncheck the other setting) ODIN will automatically create an AudioSource for you and link that to the ODIN server and handles the lifetime of it.

However, you are responsible to attach the PlaybackComponent to a GameObject representing the player (in space) and thus allowing you to implement 3D audio with ease.

Check out these guides on how to get notified of the SDK once an audio stream has been prepared and how to handle the event:

Getting Started with Unity: Create a simple Unity project and add ODIN to it. Shows the basic workflow and basic event handling.
Unity with Mirror Networking: Shows how to implement ODIN into a multiplayer game built with mirror networking. Create a simple multi-player game and add ODIN to it in under 20 minutes.

What you basically have to do is to listen on the OnCreatedMediaObject and OnDeleteMediaObject events of the OdinHandler instance like this:

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(OnDeleteMediaObject);
}

Here is a simple example on how to handle the event. More examples can be found in the reference documentation of PlaybackComponent , the OnMediaAdded event and the guides linked above.

private void OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Create or find a player object in the scene
    var peerContainer = CreateOrFindGameObject(peerId, roomName);

    // Create PlaybackComponent and add to the players GameObject
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Set spatialBlend to 1.0f to activate fill 3D audio and adjust some 3D audio settings
    // This is basic Unity stuff. PlaybackSource is an AudioSource object. See Unity documentation for more info 
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

Events

Read more about the events available in our Scripting documentation:

Room events

Event Type	Description
Room Join	Called before a player joins a room: OnRoomJoin
Room Joined	Called after a player joined a room: OnRoomJoined
Room Leave	Called before a player leaves a room: OnRoomLeave
Room Left	Called after a player left a room: OnRoomLeft

Peer events

Property	Description
Peer Joined	Called when another player joined the room: OnPeerJoined
Peer Left	Called when another player left the room: OnPeerLeft
Peer Updated	When the user data of a peer changes, this callback is called: OnPeerUserDataChanged

Warning

If the other player disables his microphone, a Media Removed event is triggered and all other peers will stop listening on this audio source.

Media events

When media streams are added or removed, you’ll receive these events.

Property	Description
Media Added	Called when the microphone stream of another user is joining the room: OnMediaAdded
Media State Changed	Called when the medias state changed: `OnMediaActiveStateChanged`
Media Removed	When one of the peers removes his microphone stream of the room, this callback is triggered: OnMediaRemoved

Microphone Reader settings

In a typical ODIN Manager Game Object a Microphone Reader component is attached which handles the players microphone and audio input. Let’s dig through these settings here: Microphone Reader .

`}),e.add({id:3502,href:"https://www.4players.io/odin/sdk/unity/manual/odinhandler/",title:"Odin Handler",section:"ODIN Documentation",description:"This Unity Component handles ODIN events and other core parts",content:`

The OdinHandler component class is the global manager (singleton) for Odin inside your game. You can use it to connect your own callbacks.

Info

ODIN uses DontDestroyOnLoad in this class to make sure that this component and game object survives scene changes.

Microphone

The first option provided in the Odin Handler Inspector is the microphone setting:

Warning

Mixer Settings

Another set of options is playback mixer settings.

Sometimes you want to apply some audio effects to voice, like cell broadcast interferences or noise. Create a Unity AudioMixerGroup or AudioMixer and assign it to one of these options.

Setting	Description
Playback Mixer	Create a Unity AudioMixer asset and drag it into this field.
Playback Mixer Group	Create a Unity AudioMixerGroup asset and drag it into this field.

Playback Creation

Info

Please note: You should only select one of these checkboxes. We’ll change that to a drop down field in the next version of the SDK.

Playback auto creation

If you check this box, the ODIN SDK will automatically create an AudioSource and link that to the ODIN server for you and will handle the lifetime for you.

In addition to that, and that distinguishes this setting to Manual Positional Audio is that the PlaybackComponent will be automatically attached to the GameObject with the OdinHandler attached.

This is the easiest way to implement a simple “video conferencing” like use case where you don’t have positional audio or specific teams.

Info

Manual Positional Audio

If you check this box (and uncheck the other setting) ODIN will automatically create an AudioSource for you and link that to the ODIN server and handles the lifetime of it.

However, you are responsible to attach the PlaybackComponent to a GameObject representing the player (in space) and thus allowing you to implement 3D audio with ease.

Check out these guides on how to get notified of the SDK once an audio stream has been prepared and how to handle the event:

Getting Started with Unity: Create a simple Unity project and add ODIN to it. Shows the basic workflow and basic event handling.
Unity with Mirror Networking: Shows how to implement ODIN into a multiplayer game built with mirror networking. Create a simple multi-player game and add ODIN to it in under 20 minutes.

What you basically have to do is to listen on the OnCreatedMediaObject and OnDeleteMediaObject events of the OdinHandler instance like this:

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(OnDeleteMediaObject);
}

Here is a simple example on how to handle the event. More examples can be found in the reference documentation of PlaybackComponent , the OnMediaAdded event and the guides linked above.

private void OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    // Create or find a player object in the scene
    var peerContainer = CreateOrFindGameObject(peerId, roomName);

    // Create PlaybackComponent and add to the players GameObject
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    // Set spatialBlend to 1.0f to activate fill 3D audio and adjust some 3D audio settings
    // This is basic Unity stuff. PlaybackSource is an AudioSource object. See Unity documentation for more info 
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;
}

Events

Read more about the events available in our Scripting documentation:

Room events

Event Type	Description
Room Join	Called before a player joins a room: OnRoomJoin
Room Joined	Called after a player joined a room: OnRoomJoined
Room Leave	Called before a player leaves a room: OnRoomLeave
Room Left	Called after a player left a room: OnRoomLeft

Peer events

Property	Description
Peer Joined	Called when another player joined the room: OnPeerJoined
Peer Left	Called when another player left the room: OnPeerLeft
Peer Updated	When the user data of a peer changes, this callback is called: OnPeerUserDataChanged

Warning

If the other player disables his microphone, a Media Removed event is triggered and all other peers will stop listening on this audio source.

Media events

When media streams are added or removed, you’ll receive these events.

Property	Description
Media Added	Called when the microphone stream of another user is joining the room: OnMediaAdded
Media State Changed	Called when the medias state changed: `OnMediaActiveStateChanged`
Media Removed	When one of the peers removes his microphone stream of the room, this callback is triggered: OnMediaRemoved

Microphone Reader settings

In a typical ODIN Manager Game Object a Microphone Reader component is attached which handles the players microphone and audio input. Let’s step through these settings here: Microphone Reader .

`}),e.add({id:3503,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/microphonereader/",title:"Microphone Reader",section:"ODIN Documentation",description:"Captures audio input from connected microphone(s) and forwards them to the ODIN runtime",content:`

Basic Settings

These are the settings exposed in the Unity Inspector for this component:

Properties

Property	Description
Redirect captured audio	Automatically send all captured audio data to all rooms this player joined. If you want more control, disable this setting.
Continue Recording	Indicates whether the recording should continue recording if AudioClipLength is reached, and wrap around and record from the beginning of the AudioClip.

Mic Audio-Clip Settings

Use these settings to adjust these behaviors.

Properties

Property	Description
Audio Clip Length	The length of the audio clip. If `Continue Recording` is enabled, this will be overwritten everytime it’s full.
Override Sample Rate	Activate this setting to specify a different sample rate than globally set in the Odin Editor Config
Sample Rate	Only visible of Override Sample Rate is active. Set the sample rate that you want to have for this microphone. >}}
Autostart Microphone	If enabled, the microphone will immediately start listening and sending audio data to ODIN. If disabled, you need to call StartListen manually.

`}),e.add({id:3504,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/microphonereader/",title:"Microphone Reader",section:"ODIN Documentation",description:"Captures audio input from connected microphone(s) and forwards them to the ODIN runtime",content:`

Basic Settings

These are the settings exposed in the Unity Inspector for this component:

Properties

Property	Description
Redirect captured audio	Automatically send all captured audio data to all rooms this player joined. If you want more control, disable this setting.
Continue Recording	Indicates whether the recording should continue recording if AudioClipLength is reached, and wrap around and record from the beginning of the AudioClip.

Mic Audio-Clip Settings

Use these settings to adjust these behaviors.

Properties

Property	Description
Audio Clip Length	The length of the audio clip. If `Continue Recording` is enabled, this will be overwritten everytime it’s full.
Override Sample Rate	Activate this setting to specify a different sample rate than globally set in the Odin Editor Config
Sample Rate	Only visible of Override Sample Rate is active. Set the sample rate that you want to have for this microphone. >}}
Autostart Microphone	If enabled, the microphone will immediately start listening and sending audio data to ODIN. If disabled, you need to call StartListen manually.

`}),e.add({id:3505,href:"https://www.4players.io/odin/sdk/unity/manual/microphonereader/",title:"Microphone Reader",section:"ODIN Documentation",description:"Captures audio input from connected microphone(s) and forwards them to the ODIN runtime",content:`

Basic Settings

These are the settings exposed in the Unity Inspector for this component:

Properties

Property	Description
Redirect captured audio	Automatically send all captured audio data to all rooms this player joined. If you want more control, disable this setting.
Continue Recording	Indicates whether the recording should continue recording if AudioClipLength is reached, and wrap around and record from the beginning of the AudioClip.

Mic Audio-Clip Settings

Use these settings to adjust these behaviors.

Properties

Property	Description
Audio Clip Length	The length of the audio clip. If `Continue Recording` is enabled, this will be overwritten everytime it’s full.
Override Sample Rate	Activate this setting to specify a different sample rate than globally set in the Odin Editor Config
Sample Rate	Only visible of Override Sample Rate is active. Set the sample rate that you want to have for this microphone. >}}
Autostart Microphone	If enabled, the microphone will immediately start listening and sending audio data to ODIN. If disabled, you need to call StartListen manually.

`}),e.add({id:3506,href:"https://www.4players.io/fleet/cli/usage/filters/",title:"Filters",section:"ODIN Fleet Documentation",description:"Learn how to filter list resources in ODIN CLI commands.",content:`

The ODIN CLI allows users to filter data using a flexible and powerful filter syntax. This is especially useful when working with large datasets, allowing you to extract exactly the information you need.

Basics

You can set a filter using the --filter flag followed by the filter expression. If omitted, the command will return all resources. Resources are filtered on the server side, but depending on command it may also be filtered on the client side or even a combination of both.

The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT.

You can access nested fields using dot notation, and strings should be enclosed in quotes. Here’s an example using a basic filter:

--filter="serverConfig.name = 'Minecraft Production 2''

This filter will return all servers where the serverConfig.name is "Minecraft Production 2".

Supported Operators

=: Equal to
!=: Not equal to
>: Greater than
<: Less than
>=: Greater than or equal to
<=: Less than or equal to
~ : Contains (for strings)

The ~ also allows usage of wildcards (*) for partial matches. For example:

--filter="serverConfig.name ~ 'Minecraft*'"

This filter will return all servers where the serverConfig.name starts with "Minecraft".

Combining Filters

You can combine multiple conditions using AND and OR operators:

AND: Both conditions must be true.
OR: At least one condition must be true.

--filter="serverConfig.name = 'Minecraft Production 2' AND id > 100"

This filter will return all servers where the serverConfig.name is "Minecraft Production 2" and the id is greater than 100.

Negation with `NOT`

You can negate conditions using the NOT operator. For example:

--filter="NOT (serverConfig.name = 'Minecraft Production 2')"

This will return all servers where the serverConfig.name is not "Minecraft Production 2".

Accessing Nested Properties

You can filter based on nested properties using dot notation. For example, if you want to filter servers based on a nested property like serverConfig.name, you can do:

--filter="serverConfig.name = 'Minecraft Production 2'"

Here’s an example using the serverConfig object from a typical server JSON structure (just the interesting part is shown here):

{
  "id": 134,
  "serverConfig": {
    "name": "Minecraft Production 2",
    "status": "ready"
  }
}

This filter will return all servers with the serverConfig.name set to "Minecraft Production 2".

Examples

Filtering Servers by Config

odin fleet servers list --filter="serverConfig.status = 'ready' AND serverConfig.name = 'Minecraft Production 2'"

This filter will return servers that are ready and have the name "Minecraft Production 2".

Combining Logical Conditions

odin fleet servers list --filter="(serverConfig.status = 'ready' AND serverConfig.name = 'Minecraft Production 2') OR id = 211"

This will return servers that either:

Have a serverConfig.status of "ready" and a serverConfig.name of "Minecraft Production 2", or
Have an id of 211.

Negating Conditions

odin fleet servers list --filter="NOT (serverConfig.status = 'ready')"

This filter will return all servers where the serverConfig.status is not "ready".

Filtering by Ports

If you need to filter based on the ports object in the server JSON, you can do so using nested access. For example, to filter by the publishedPort in Game Port:

odin fleet servers list --filter="ports['Game Port'].publishedPort = 30097"

This will return servers where the published game port is 30097.

Practical Use Cases

Filtering for Inactive Servers

You can quickly filter for servers that are not running:

odin fleet servers list --filter="status.state != 'running'"

This returns all servers whose status.state is not running.

Filtering by Location

If you need to filter servers based on their location, you can access the location object:

odin fleet servers list --filter="location.country = 'de' AND location.city = 'limburg'"

This will return all servers located in the city of Limburg, Germany.

Advanced Filters

You can also create more complex filter expressions that combine multiple conditions:

odin fleet servers list --filter="(serverConfig.name = 'Minecraft Production 2' OR serverConfig.name = 'ODIN Fleet') 
AND location.country = 'de'"

This filter will return servers with either the name "Minecraft Production 2" or "ODIN Fleet" that are located in Germany.

`}),e.add({id:3507,href:"https://www.4players.io/fleet/cli/usage/global-flags/",title:"Global Flags",section:"ODIN Fleet Documentation",description:"Learn about the global flags available for the ODIN CLI.",content:`

The ODIN CLI supports a number of global flags that can be used with any command. These flags are used to control the behavior of the CLI and can be used to set options like the output format, verbosity, and more.

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3508,href:"https://www.4players.io/fleet/cli/usage/output-formatting/",title:"Output Formatting",section:"ODIN Fleet Documentation",description:"Learn how to format the output of ODIN CLI commands.",content:`

The ODIN CLI supports various output formats to accommodate different needs, such as human-readable formats for direct interaction and machine-readable formats for scripts and automation.

Basics

The output format can be set using the --format flag. If omitted, the default format is used that is specific to each command. If values to be printed in tables or as a value are objects or arrays, they are automatically converted to JSON format.

I.e. the Servers object has a hash map of ports. If you want to print the published ports of your server, you can use the following command:

odin fleet servers list --format="table(id,addr,ports)"

This will output a table with the server ID, IP address, and the ports object in JSON format. You can also access nested properties by using the dot syntax. If you want to print the published game port of your server, you can use the following command:

odin fleet servers list --format="table(id,addr,ports['Game Port'].publishedPort)"

The Game Port is the name of the port configuration you created in the server configuration. The publishedPort is the port that is actually used by the server.

Default Output

The default format is human-readable and designed to be intuitive for each command.

JSON Output

The json format outputs the command results in JSON format, conforming to the API specifications. This is useful for processing data programmatically.

odin <command> --format=json

Table Output

The table(propertyList) format prints the result in a table format. The propertyList is a comma-separated list of properties you want to display as table columns. Nested properties can be accessed using the dot syntax (e.g., serverConfig.id).

odin <command> --format="table(id,name)"

Example:

odin fleet servers list --format="table(id,addr,ports['Game Port'].publishedPort)"

This would display a table with columns with the id, the servers IP address and the published game port.

Flattened Output

The flattened[noPad,separator='->'](propertyList) format prints a simple key value pair output, where each property is displayed on a new line. The separator attribute allows you to define a custom separator between the key and value.

odin <command> --format="flattened(id,name)"

Optional Attributes:

noPad: Disables padding, resulting in a more compact output.
separator: Changes the default separator (:) to any other character(s).

Example:

odin fleet servers list --format="flattened[separator='->'](id,name)"

This would output:

id->12345
name->MyServer

Value Output

The value[separator='->'](propertyList) format prints only the values of the specified properties in a single line, separated by the chosen separator (default is tab).

odin <command> --format="value[separator=':'](id,name)"

Optional Attributes:

separator: An optional attribute that lets you define a custom separator for the values.

Examples:

odin fleet servers list --format="value[separator=':'](id,name)"

This would output:

12345:MyServer

It’s a powerful tool for extracting specific information from the output of a command. I.e. it’s super useful in scripts or automation tasks. For example when creating an item you can use the value format to just get the ID of the created item. That can easily be used in the next command.

IMAGE_ID=$(
  odin fleet images create \\
  --name="Example Image" \\
  --type="dockerImage" \\
  --docker-image="example/example-image:latest" \\    
  --registry-id=1 \\
  --force \\
  --format="value(id)")
  
echo "Created image with ID: $IMAGE_ID"

This would store the ID of the created image in the IMAGE_ID variable.

Advanced Property Lists

Property lists can be very flexible and powerful, especially when dealing with nested data or arrays. Here are some advanced examples:

Accessing Nested Properties

odin fleet servers list --format="value[separator=':'](id,serverConfig.id)"

Output:

12345:67890

Indexing Arrays

odin fleet configs list --format="value[separator=':'](id,name,env[0].key,env[0].value)"

This would output the first key-value pair in the env array.

Functions

Functions can be used in the property list to manipulate the data before it is printed. Functions have this format: functionName(parameter).

Info

While parameters in the property list are acting on individual items in the data, functions are acting on the entire dataset. Example: You have a list with 5 items. value(id) will return the ID of each item, while value(count(id)) will iterate over each item in the dataset and return the number of items that have an ID (so all of them).

You can combine functions with parameters, but that might not always make sense. For example, value(count(id),id) would return something like this:

Counting Items

Parameters in the property list can also be functions. This can be useful for counting items. For example, to count the number of configs. You can also combine that with filters to count specific items.

Return the number of running servers:

odin fleet servers list --format="value(count(id))" --filter="status.state='running'"

`}),e.add({id:3509,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/playbackcomponent/",title:"Playback Component",section:"ODIN Documentation",description:"This component handles ODIN audio playback",content:`

This component is automatically created and attached during runtime when you call the method AddPlaybackComponent on the OdinHandler singleton in your scene.

Do not add this component manually in the editor.

More info on this topic can be found here:

OdinHandler reference documentation
OnMediaAdded event and how to use it
Unity Multiplayer Game Integration Guide

`}),e.add({id:3510,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/playbackcomponent/",title:"Playback Component",section:"ODIN Documentation",description:"This component handles ODIN audio playback",content:`

This component is automatically created and attached during runtime when you call the method AddPlaybackComponent on the OdinHandler singleton in your scene.

Do not add this component manually in the editor.

More info on this topic can be found here:

OdinHandler reference documentation
OnMediaAdded event and how to use it
Unity Multiplayer Game Integration Guide

`}),e.add({id:3511,href:"https://www.4players.io/odin/sdk/unity/manual/playbackcomponent/",title:"Playback Component",section:"ODIN Documentation",description:"This component handles ODIN audio playback",content:`

This component is automatically created and attached during runtime when you call the method AddPlaybackComponent on the OdinHandler singleton in your scene.

Do not add this component manually in the editor.

More info on this topic can be found here:

OdinHandler reference documentation
OnMediaAdded event and how to use it
Unity Multiplayer Game Integration Guide

`}),e.add({id:3512,href:"https://www.4players.io/fleet/cli/usage/",title:"Usage",section:"ODIN Fleet Documentation",description:"Get started with ODIN Fleet CLI",content:`

The ODIN CLI is a comprehensive command-line tool for managing and interacting with the game server hosting services provided by 4Players. With this tool, you can manage apps, configure fleets, deploy servers, and perform various other operations directly from your terminal.

Key Features

Error Handling: In case of an error, the CLI sends an error message to stderr and exits with code 1.
Successful Execution: If everything works as expected, the CLI exits with code 0 and prints the result to stdout.
Output Formatting: Customize the output format using the --format flag.
Force Execution: The --force flag allows bypassing confirmation prompts.
Quiet Mode: The --quiet flag suppresses informational messages, providing a cleaner output.

You can use the internal help command to get a list of available commands and their descriptions:

odin --help

You can get help for a specific command by running the following command:

odin <command> --help

Authentication

Before using the CLI, users must authenticate by providing their API key. The API key can be obtained from the 4Players Console. The API key can be provided either during the initial setup or via the --api-key parameter, which is particularly useful in CI/CD environments.

To log in:

odin login --api-key=<YOUR_API_KEY>

If you omit the --api-key parameter, the CLI will prompt you to enter the API key interactively.

App Selection

Users must select an app before executing certain commands. This can be done interactively or by providing the app ID directly with the --app-id parameter, which is especially useful in automated scripts.

To select an app interactively:

odin apps select

To use a specific app via the command line in any command just add the --app-id parameter overriding the selected app:

odin <command> --app-id=<APP_ID>

`}),e.add({id:3513,href:"https://www.4players.io/odin/guides/unity/getting-started-unity/",title:"Getting Started with Unity",section:"ODIN Documentation",description:"Discover how to set up realtime 3D positional voice chat using ODIN in Unity in just 20 minutes. Enhance your game's immersion and communication with this step-by-step guide.",content:`

At the end of this guide, you’ll be able to chat with friends and colleagues with realtime voice positioned in 3D. It will take around 20 minutes of your time to finish this guide.

Info

Please note: Although it’s not required to understand the basic concepts of ODIN to follow this guide, it’s definitely helpful. We try our best to give some explanation in this guide, however, if you are not in a hurry, we recommend reading through the introduction first.

Requirements

Supported platforms

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Create an empty Unity project

First, you’ll need to create an empty Unity project. Please note that ODIN requires Unity version 2019.4 and later. In this guide we used version 2020.3.17f1, but feel free to use what you have installed. We also used the Unity Hub version 3.0.0 - if you are using an earlier version of the hub your screen might look a bit different, but the steps are basically the same.

Creating a new 3D project in Unity with the Unity Hub.

Please choose the 3D template, choose a folder on your hard disk and click on Create Project. After a few moments the Unity Editor will start, presenting an empty scene in a new project.

Install ODIN SDK

Next step is to install the ODIN Unity SDK in the new project.

⚠️

Important: Please remove files of previous versions before installing a new version. Unity does not remove old files from the installation and this causes issues sometimes. So just remove the package and install the latest one. 4Players ODIN also supports Apple Silicon. Check out our FAQ to learn more on prerequisites for running ODIN with Apple Silicon.

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Acquire the plugin from the Unity Asset Store. Press the button Open in Unity or just open your Unity project and use the Package Manager to go to My Assets and select Odin Voice Chat to download and import it.

Install via Unity Package

Please download the latest version of the ODIN Unity SDK as a .unitypackage from the [Github releases page] (https://github.com/4Players/odin-sdk-unity/releases). Just double-click the .unitypackage to import it into your current Unity editor project.

Package Manager

Using the Package Manager will ensure that all dependencies are set up correctly and that you will have the most up-to- date version of the SDK. In most cases, using the Package Manager is the way to go.

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Install the samples

In the next step, we need to install the samples, so we can use them directly in the Unity editor. Open the Package Manager. Click on the menu Window and then Package Manager. A new window will pop up:

Make sure that Packages: In Project is selected in the dropdown (see highlighted box in screenshot above), otherwise click on it and choose Packages: In Project to show all packages installed in this project. In the list, you should see 4Players ODIN.

Click on the 4Players ODIN item in the list on the left side. You’ll see some package details. Expand the Samples collapsible section to reveal available examples and click on the Import button to install the samples.

Loading the sample scene

After a couple of seconds, the samples will be installed in your Assets folder as you can see in this screenshot:

Navigate to the Assets/Samples/4Players ODIN/__VERSION__/Examples/Positional Audio folder in your asset browser.

Tip

Please note, __VERSION__ stands for the current version number of the ODIN SDK. As you can see in the screenshot above, the latest version number was 0.4.3 when this guide has been written.

Double-click on the sample scene Sample3dScene to load the scene (highlighted in the screenshot) in the Unity editor.

Understanding the scene

The scene has a couple of Game Objects. Let’s explore them one after the other:

Main Camera: This is the main camera of the scene.
Event System: This sample requires an EventSystem (you can create it in your own project in the menu GameObject -> UI -> Event System)
Directional Light: A light, otherwise it’s kind of dark
Player: An instance of the Player prefab. You can find the prefab in the Assets/Samples/4Players ODIN/__VERSION__/Examples/Positional Audio/Player.prefab file. This object represents the player in this scene, i.e. the person sitting in front of the device. We’ll have a closer look at this object later in this guide.
ODIN Manager 3D Variant: This object manages communication with ODIN servers and allows you to set up various settings. If you are curious, you can find a manual of all those settings here
Plane: The plane that acts as a simple “floor” in this scene.

Setting an ODIN access key

Select the ODIN Manager 3D Variant GameObject in the hierarchy. The inspector on the right side will reveal all ODIN settings. We now need to set an access key that will allow the client (in this case the Unity Editor) to connect to ODIN servers.

Info

This is an important topic, that we don’t want to dive in deeper right now, but you’ll have to take a minute to understand that later. Check out our guide on this topic here: Understanding Access Keys.

As we want to keep things simple, you can generate an access key right from Unity. Expand the Client Authorization collapsible to reveal the authorization settings:

Click on the Manage Access . You’ll see a dialog like this:

Click on the Generate Access Key to generate an access key for free. This will allow you to connect with up to 25 users. Don’t use this access key in production!

Close the Access Key Manager window. Now you should see the access key set in the Client Authorization inspector.

Warning

Some users reported that the generated access key is deleted by the Unity editor after navigating around. This seems to be a Unity bug. As a work-around, after pressing the “Generate Access Key”, copy the Access key from the inspector field, empty it with DELETE and copy it in again. This way the access key is stored by the inspector.

Running the sample

Congratulations. Let’s test the sample scene. Press the Play button in the Unity Editor. You should see something like this:

You’ll see the Player GameObject from a top-down view. You’ll notice that the microphone is active and recording. On platforms like macOS, iOS, or Android, you may need to grant Unity permission to access your microphone beforehand.

You can drag & drop the Player cube with your mouse to position it somewhere else on the scene. That will become important later to experience 3D audio.

As always with voice chat, it’s boring if you are alone. So let’s get some other guys in the room.

Building the project

To get in more users, we’ll need to build the project, so we can share the binary with friends or colleagues. Open the build settings window by navigation to the menu File -> Build Settings.

Click on the Add Open Scenes button to add the current scene to the list.

Warning

Very important for Mac users: If you want to build for macOS or iOS, you need to set a string for microphone usage in the player settings. Otherwise, Unity editor will fail to build the target with obscure error messages. We have compiled a guide how to set that, and you can find it here.

Click on the Build and Run button to build the current scene and running it on your own machine. You’ll need to provide a folder on your hard disk where the binary will be created.

After some time, you should see the application running fullscreen on your machine. Unity typically defaults to running things in fullscreen. It’s a bit easier to test with multiple instances of the app if they run in windowed mode. Let’s change that setting.

Navigate to the menu Edit -> Project Settings. The Project Settings Window will appear. Choose Player Settings on the left side and expand the Resolution and Presentation collapsible.

Testing ODIN

Ok, now that we optimized our app settings, let’s build and run the app again. Choose File -> Build and Run. The app should run in windowed mode now.

Now, get back into the Unity Editor and click on Play.

Sample app running as app and in the editor

Now, finally, something interesting happens: You see another cube in the scene. If your volume is too high, or your mic is too sensitive, you might hear an echo: That is, because both peers are running on the same machine with the same input - which does not make much sense but for testing it is ok.

If you say something, you’ll hear your own voice. Now, begin to drag & drop the cubes around and notice how the direction changes depending on the relative position each cube has to each other.

You can send the binary to your friend or colleague to test ODIN in a more realistic scenario.

Warning

Please note: The position of the cubes is not synced over the network, as we want to keep things as simple as possible in this example. So, every peer can drag & drop the boxes around and will hear the voices from a direction that he has set up on screen! Please keep that in mind when testing, e.g. if you ask your colleague: “Do you hear me from the right”, they might hear you from the front or from the left, as they might have different cube positions on their screen. That shows, that ODIN is a pure client side and deep engine integration - and thus very flexible and easy to use.

How does it work?

Congratulations, you now have a working example of ODIN integrated with 3D audio. Let’s have a deeper look at it to understand how everything works.

ODIN is a client-server solution, which means that ODIN clients, i.e. applications built with Unity
or the Unity Editor itself, are connecting to ODIN servers and joining rooms. Every client connected to the same room
can listen to all audio streams of the other clients connected to a room. Every client may send audio in the room,
but does not have to. They may be muted or may just listen to the audio streams (e.g. spectators).

These days, everyone is talking about 3D spatial audio (for example Apple Airpods use this technology). What that means is, that the audio solutions tries to replicate how things work in the real world. Humans know from which direction sound comes from, and they can even estimate the distance because sound is louder if closer and more quiet if far away.

The opposite would be a phone call with headphones on your ears. It does not make any difference how far the other person on the line (i.e. in the same room in ODIN terminology) is, it’s always coming from the same “direction” it sounds like right in front of you and the volume is the same.

With ODIN, you can replicate both variants, or even mix them. There is only one setting in Unity that makes the whole difference: spatialBlend available in AudioSource .

ODIN is deeply integrated into the game engine instead of being a layer above. ODIN therefore uses core Unity technology:

AudioListener : This is the players ear within the scene. The position of the GameObject is important if you are using 3D spatial (positional) audio. Typically, this is attached to the player GameObject or the camera if you are not using 3D audio for voice.
AudioSource : An AudioSource in Unity acts as the ‘speaker’ that generates sound within the scene. The AudioSource component has a setting called spatialBlend , which determines whether the sound is spatial (3D) or non-spatial (2D). If you want the sound to be part of the 3D environment (i.e., affected by the object’s position relative to the listener), set spatialBlend to 1.0. On the other hand, if you want the sound to be heard at a constant volume regardless of the object’s position (e.g., for sounds like collecting a coin), set it to 0.0.

Every peer and attached media on ODIN servers need to be replicated within Unity at runtime as shown in the diagram below. Every peer in ODIN is typically replicated (depending on the use case) in Unity as a GameObject, this can be just a player name in a list in a chat application or a Player object in a multiplayer game. Every media (i.e. microphone) attached to a peer within an ODIN room is replicated in Unity with a PlaybackComponent which is typically a child of the player object being the AudioSource of the microphone linked to that peer.

graph LR;
    subgraph Unity Scene
        subgraph Player1 [Player 1]
            PBC1[PlaybackComponent]-->GO1[GameObject]                   
        end
        subgraph Player2 [Player 2]
            PBC2[PlaybackComponent]-->GO2[GameObject]
        end
        
    end
    subgraph ODIN Server
        subgraph ODIN Room
            Peer1[Peer 1] --> Media11[Media 1]--> PBC1
            Peer2[Peer 2] --> Media21[Media 2]--> PBC2
        end    
    end    
    classDef blue fill:#DDFAFF
    class Player1,Player2 blue

To build this hierarchy we need to listen to certain events and handle them. Don’t worry, it’s super easy and just requires a couple lines of code.

In the next section we’ll have a closer look at how this is done:

The ODIN Manager Object

The first object that we’ll have a closer look is the OdinManager 3D Variant object. You already know this Game Object as you used it to set up your access key.

The scripts attached to the Player object

If you look closer, you’ll notice there are a couple of scripts attached to this GameObject:

Odin Editor Config: The Odin Editor Config script allows you to set up ODIN within your game and handles client authorization and is part of the ODIN SDK.
Odin Handler: This script does all the event handling and exposes various settings for the microphone and audio effects. See the manual of Odin Handler for a documentation of all the settings available and how to use the API. This class is also part of the ODIN SDK.
Microphone Reader: This class is part of the ODIN SDK and captures the audio input from the microphone connected to the players PC and sends it to ODIN servers once the client joined an ODIN room. See the Microphone Reader for more info on this component.
Simple Push To Talk: This script is part of the sample code and uses the ODIN SDK to implements joining a room and “Push to Talk” (i.e. the microphone is always muted, and you need to press a button to unmute while talking). We’ll have a closer look at this script in the next paragraph.

Simple Push To Talk

Let’s have a look at the SimplePushToTalk.cs script provided with the sample. It uses various APIs provided by the ODIN SDK to join a room and to implement push to talk logic.

Basic Push to Talk

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

using OdinNative.Unity.Audio;

namespace OdinNative.Unity.Samples
{
    public class SimplePushToTalk : MonoBehaviour
    {
        public string RoomName;
        [SerializeField]
        public KeyCode PushToTalkHotkey;
        public bool UsePushToTalk = true;
        public MicrophoneReader AudioSender;

        private void Reset()
        {
            RoomName = "default";
            PushToTalkHotkey = KeyCode.C;
            UsePushToTalk = true;
        }

        // Start is called before the first frame update
        void Start()
        {
            if (AudioSender == null)
                AudioSender = FindObjectOfType<MicrophoneReader>();

            OdinHandler.Instance.JoinRoom(RoomName);
        }

        // Update is called once per frame
        void Update()
        {
            if (AudioSender)
                AudioSender.RedirectCapturedAudio = UsePushToTalk ? Input.GetKey(PushToTalkHotkey) : true;
        }
    }
}

We need to join a room so that we can chat with other peers in that same room. To do this, the SimplePushToTalk script takes the RoomName parameter given in the Inspector and connects to that room with the JoinRoom function of the instance of the Odin Handler .

The OdinManager 3d Variant also has a Microphone Reader script attached. This script handles microphone input and sends it to all ODIN rooms that the player has joined. But, as we only want to send audio input when a specific button is pressed, we’ll get a reference to the MicrophoneReader instance in the Start function and set the RedirectCapturedAudio to true if audio should be sent (i.e. if Push to Talk is activated and selected button is pressed) or false if no audio should be sent to the server.

So, that’s it. As you can see, the ODIN 3D Manager handles a couple of settings like client authorization (access key), handles microphone input and sends data to the server if the user has pressed a button.

Info

Please note: Per default, ODIN has RedirectCapturedAudio set to true which means that microphone input is always sent to ODIN servers. You need to change the setting in the inspector of use a script like shown above to customize that to your needs. Push to talk is just one example.

The Player Object

The second Game Object, that we want to take a close look at is the Player object in the scene. Select it, and you’ll notice a couple of scripts attached to this object:

Audio Listener: In many games, the audio listener is attached to the camera. In this case, we want the player’s “ears” to be positioned at the player’s location, which is important because we want Unity to calculate audio from other sources relative to the player’s position, not the stationary camera above the scene. Please note that the AudioListener is a standard Unity component.
Drag Object: This is just a simple script that allows you to drag & drop the cube. We won’t go into detail on how this is implemented, but feel free to have a look at the script in your preferred IDE.
Odin 3d Trigger: This script handles some ODIN events and creates the peer cubes. We’ll dive into this script in a minute.

Odin 3d Trigger

The Odin3dTrigger.cs script is handling a couple of ODIN events and creates the peers whenever a peer connects. It’s a bit longer, so we go through it step, by step.

In the Start function, we’ll listen to some ODIN events. In this example we do it by code, but please feel free to connect them via the Unity Inspector (see Odin Handler manual for more info on that).

Handling events

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(Instance_OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(Instance_OnDeleteMediaObject);
    OdinHandler.Instance.OnRoomLeft.AddListener(Instance_OnRoomLeft);

    var SelfData = OdinHandler.Instance.GetUserData();
    //Set Player
    GameObject player = GameObject.FindGameObjectsWithTag("Player").FirstOrDefault();
    if (player != null)
    {
        TextMesh label = player.GetComponentInChildren<TextMesh>();
        label.text = CustomUserDataJsonFormat.FromUserData(SelfData)?.name ?? player.name;
    }
}

So, we listen to the OnCreatedMediaObject , OnDeleteMediaObject and OnRoomLeft events:

OnCreatedMediaObject: Triggered whenever a peer started sending audio data
OnDeleteMediaObject: Triggered whenever a peer stopped sending audio data
OnRoomLeft: Triggered when a peer left a room.

We also get the User Data of the user and set the text label of the player object to the player name (if available).

Now, as you can see, we need to have some callback methods for these events, let’s have a look step by step:

Handling On Media Created Events

This event is triggered whenever a peer joined a room and started to send audio data. There is a difference between a peer joining a room and media added to that room for that peer, because peers may only join a room without sending their own data (i.e. spectators). So, to simplify things we just handle the case when a player joined to the room starts sending audio (which is the OnCreatedMediaObject event):

The OnMediaAdded implementation

GameObject CreateObject()
{
    return Instantiate(prefab, new Vector3(0, 0.5f, 6), Quaternion.identity);
}

private void Instance_OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    var peerContainer = CreateObject();

    //Add PlaybackComponent to new dummy PeerCube
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    //Some AudioSource test settings
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;

    //set dummy PeerCube label
    var data = CustomUserDataJsonFormat.FromUserData(room.RemotePeers[peerId]?.UserData);
    playback.gameObject.GetComponentInChildren<TextMesh>().text = data == null ?
        $"Peer {peerId} (Media {mediaId})" :
        $"{data.name} (Peer {peerId} Media {mediaId})";

    PeersObjects.Add(playback.gameObject);
}

This callback does four things:

Instantiate a peer cube (from the peer prefab) which represents the peer in the scene as a cube with the CreateObject function.
Attach the audio source for that peer to the instantiated peer GameObject. ODIN SDK provides a function AddPlaybackComponent for that. It creates a PlaybackComponent and attached it to the peer cube GameObject. The function also returns the PlaybackComponent instance so that we can customize it in the next step.
The PlaybackComponent uses a Unity AudioSource for “sending” audio into the scene. You can get your hands to that audio source using the PlaybackSource property. In this sample, the spatialBlend value is set to 1.0 to activate 3D spatial audio for peers and a couple of other settings like the volume attenuation is set.
Use the User Data of the peer to get its name and set the label of that peer to that name. This allows us to identify the peers in the scene.

Some experiments

Let’s do some experiments with the sample that we have right now to showcase the power of ODIN and to give you an idea what you can do with it in your game.

In the Odin3dTrigger.cs script, in the Instance_OnCreatedMediaObject function adjust some settings made to the PlaybackComponent.PlaybackSource. As this is a standard Unity AudioSource object, you’ll find the component in the Unity documentation. Here are a couple of things you can try:

Switching to “gods voice”

Change the line where spatialBlend is set into this:

Disabling 3D audio

playback.PlaybackSource.spatialBlend = 0.0f; //Disable 3D audio

This just disables 3D audio and every ODIN AudioSource in the scene will always have the same volume. That is basically the same experience as if all players would use an external voice chat solution like TeamSpeak or Discord. The voice is “decoupled” completely from the Gameplay. It may be useful if you want to replicate phone calls or CB communication between team members.

Please note, that spatialBlend is a float value. You can also set it to 0.5f to have something in between.

Adjusting voice attenuation

Right now, peers can only be heard up to 10 units. Reduce that to 2 and you’ll only hear peers that are very close to you. You can use these properties to implement “sound damping” dependent on the current location of the peer relative to the player.

Setting voice attenuation

playback.PlaybackSource.minDistance = 1;
playback.PlaybackSource.maxDistance = 2;

Summary

1	ODIN SDK	Install the ODIN SDK into your project.
2	Add ODIN Manager	Drag & Drop the ODIN Manager Prefab into your scene.
3	Access Key	Create and set an access key in the Unity inspector.
4	Handle ODIN events	Handle some ODIN events like shown above or described in the Event Handling guide and use AddPlaybackComponent to create the other players audio sources and attaching them to player objects in your scene.

That’s it! There’s not much more to do to integrate ODIN into your project. Of course, there are plenty of APIs available to customize the experience to suit your needs. Keep in mind that ODIN integration is fully native to Unity—you’re working with Unity as usual, without the need for unfamiliar APIs or sending additional data to external servers.

Of course, if you are working on a multiplayer game, things are a little bit more complex, but just a little bit. We have created a guide where you create a complete multiplayer game with Mirror Networking and add ODIN to it. After a couple of minutes you’ll have the same example as this one, but player positions will be synced between all peers.

Next steps

Now that you have a working example find out more about the components ODIN has to offer.

Read our Event Handling guide to learn which events you need to implement. It shows an example of basic walkie-talkie like voice combined with 3D positional audio.
Check out the Unity manual with more info on the components and what the various settings are for.
Check out the API Reference with a comprehensive documentation on all classes and interfaces exposed by the ODIN SDK.
Follow our guide on how to add Unity to a Mirror Networking based multiplayer game. After 20 minutes you’ll have a fully working multiplayer game with 3D positional voice chat and synced player positions
In our Photon open-source sample you can download and play around with a working example based on Photon Pun.

`}),e.add({id:3514,href:"https://www.4players.io/fleet/cli/fleet/images/",title:"Images",section:"ODIN Fleet Documentation",description:"Learn how to work with ODIN Fleet images using the CLI.",content:`

Images are the base building blocks of your deployments. They contain the software and configuration needed to run your game servers and services. This guide will show you how to manage images in your ODIN Fleet account using the CLI.

Warning

In code, we sometimes refer to images as Binary. This is the same thing as an Image. In some data structures (like in ServerConfig) we refer to deployments in a binaryId. We plan to deprecate this terminology in the future.

Overview

The images commands allow you to manage images in your account. You can create new images, list existing images, and delete images that are no longer needed.

Usage

odin fleet images <command>

Commands

List: List all images in your account.
Get: Display detailed information about an image.
Create: Create a new image.
Delete: Delete an image.
~Update~: Update an image (not yet implemented).

`}),e.add({id:3515,href:"https://www.4players.io/odin/introduction/",title:"Introduction",section:"ODIN Documentation",description:"An introduction to 4Players ODIN",content:`

With ODIN, 4Players provides a complete, out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers so you don’t need to spend valuable resources designing a comms solution on your own.

How does it work?

graph BT
  subgraph ODIN Server
    OR2[Odin Room]
    OR[Odin Room]    
  end
  subgraph Gameserver
    GS[Game Server]
  end
  subgraph Game
    ClientA[Player A] --> OR[ODIN Room]
    ClientB[Player B] --> OR[ODIN Room] 
    ClientB[Player B] --> GS[Game Server]   
    ClientC[Player C] --> GS[Game Server]
    ClientC[Player C] --> OR[ODIN Room] 
    ClientD[Player D] --> GS[Game Server]
  end
  subgraph Lobby
    ClientE[Players E] --> OR2[ODIN Room]
    ClientF[Players F] --> OR2[ODIN Room]
  end

The possibilities are endless, and you don’t need to be an audio or server expert! We have compiled a couple of use-cases if you are still unsure if ODIN fits for needs.

Install the SDK, add a couple lines of code to join a room and handle three callbacks. That’s it! Follow our step-by-step guides and have a running example you can share with your collegues in less that 20 minutes! No registration required, all within Unity or Unreal!

ODIN Dashboard

While you can create access keys on the go directly in the SDK or here in the documentation, those access keys are only valid for up to 25 users. If you have subscribed to a paid tier, you can create access keys that handle unlimited users in our dashboard. You can also set limits to manage your budget.

If you have subscribed to a paid tier, we already have created a project for you. You can create multiple access keys for different apps or projects or even external developers - so that you can revoke them once they are finished.

In the dashboard you’ll also find latest stats on your usage and peak number of users.

Go to ODIN Dashboard

Key Benefits

By integrating ODIN technology into your game, you can enjoy several benefits including:

Cutting Edge Technology

ODIN is the result from years of expertise and experience. 4Players combines business and industry insight with a very modern technology stack to drive growth for your business.

Easy to Get Started

Our SDKs include extensive documentation as well as numerous code samples allowing you to get the integration done in just a few days. Shorten time to market by using our best-in-class technology to deliver seamless in-game communication and improve your retention.

Highly Optimized

We took a lot of effort to make sure you can focus your time and resources on building the game you envisioned. ODIN is highly optimized, so developers can allocate more resources to other features of their game.

Truly Cross-Platform

ODIN knows no boundaries or limitations and interoperates across platforms ensuring seamless communication and collaboration for users on any device. Our native SDK libraries are available for various desktop operating systems including Microsoft Windows, macOS and Linux as well as mobile devices running iOS or Android. Additionally, we provide integrations for major game engines such as Unity and Unreal Engine All major web browsers are also supported.

🚧

Support for gaming consoles is planned for early 2022 and will cover Microsoft Xbox, Sony PlayStation 4/5 and Nintendo Switch.

Seemless Integration

Our technology can be fully integrated into any game so players don’t need to interrupt the game experience to switch to a third-party app like TeamSpeak or Discord.

Immersive Gaming without Limits

In contrast to relying on external apps, integrating comms right into the game allows creating unique, ultra-realistic and immersive gaming experiences. Using features like spatial audio and custom filters, there are no limits to creativity. Plus, there is absolutely no interference with existing technology you might be using.

No Data Mining

Privacy and security is very important to us. ODIN is completely user agnostic and we don’t harvest any data or tell you how things should work or look. You are in complete control.

Massively Scalable

Built with flexibility in mind, ODIN scales as your project requirements increase. Chat rooms are created on demand. Whether your game has 10 or 10 million concurrent users, the service just works.

Cloud or On-Premise Hosting

Choose between a managed cloud and a self-hosted solution. Let us deal with the setup, administration and bandwidth costs or run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. The choice is yours.

Flexible and Cost Effective

User interaction is vital to building thriving communities within games. As a game developer, you can just download and use the SDK for free for up to 25 concurrently connected users (CCU). Or you can order the Starter package today to be among the first studios to integrate ODIN. For the first 12 months we offer the full toolset with unlimited CCUs for a very small price and a little branding.

Basic Concepts

Next, we recommend learning more about the basic concepts of ODIN. The basic flow of joining a room and adding media like a microphone to it. Handling events being triggered as other players are joining the same room.

Next: Basic Concepts

Getting started

Can’t wait to get started and experiencing ODIN? Then stop reading and start digging by following our getting started guide. Choose your platform and you’ll have ODIN up and running withing the next 20 minutes!

You might want to watch this Unreal video tutorial series

or watch this Unity video tutorial series

Unity

Use our deep Unity integration to add the most immersive in-game voice chat to your product with minimal development overhead.

Unreal Engine

Our upcoming Unreal Engine plugin will feature full support for all available platforms and come with Blueprint and C++ support.

Web Browser

Our NPM package will feature full real-time communication support for all major web browsers including voice activity dectection.

Swift

Integrate OdinKit into your iOS and macOS apps and add real-time voice communication in a couple of minutes and with zero maintenance or operations.

`}),e.add({id:3516,href:"https://www.4players.io/fleet/cli/login/",title:"Login",section:"ODIN Fleet Documentation",description:"Learn how to authenticate the ODIN CLI with your API key.",content:`

The login command is used to authenticate the CLI with your API key. It only needs to be run once, as the CLI will store the API key in a configuration file on your system.

Usage

odin login [--api-key=YOUR_API_KEY]

Flags

--api-key=YOUR_API_KEY:
The API key to authenticate with. If you omit the --api-key parameter, the CLI will prompt you to enter the API key interactively.

After logging in, the CLI will store the API key in a configuration file on your system. Next, you can select an app to work with using the odin apps select command.

`}),e.add({id:3517,href:"https://www.4players.io/odin/offline-doc-getting-started-unity/",title:"ODIN Offline Documentation | Getting Started with Unity",section:"ODIN Documentation",description:"Discover how to set up realtime 3D positional voice chat using ODIN in Unity in just 20 minutes. Enhance your game's immersion and communication with this step-by-step guide.",content:`

At the end of this guide, you’ll be able to chat with friends and colleagues with realtime voice positioned in 3D. It will take around 20 minutes of your time to finish this guide.

Info

Requirements

Supported platforms

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Create an empty Unity project

Please choose the 3D template, choose a folder on your hard disk and click on Create Project. After a few moments the Unity Editor will start, presenting an empty scene in a new project.

Install ODIN SDK

Next step is to install the ODIN Unity SDK in the new project.

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Add your game to our library

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Install the samples

Loading the sample scene

After a couple of seconds, the samples will be installed in your Assets folder as you can see in this screenshot:

Navigate to the Assets/Samples/4Players ODIN/__VERSION__/Examples/Positional Audio folder in your asset browser.

Tip

Please note, __VERSION__ stands for the current version number of the ODIN SDK. As you can see in the screenshot above, the latest version number was 0.4.3 when this guide has been written.

Double-click on the sample scene Sample3dScene to load the scene (highlighted in the screenshot) in the Unity editor.

Understanding the scene

The scene has a couple of Game Objects. Let’s explore them one after the other:

Main Camera: This is the main camera of the scene.
Event System: This sample requires an EventSystem (you can create it in your own project in the menu GameObject -> UI -> Event System)
Directional Light: A light, otherwise it’s kind of dark
Player: An instance of the Player prefab. You can find the prefab in the Assets/Samples/4Players ODIN/__VERSION__/Examples/Positional Audio/Player.prefab file. This object represents the player in this scene, i.e. the person sitting in front of the device. We’ll have a closer look at this object later in this guide.
ODIN Manager 3D Variant: This object manages communication with ODIN servers and allows you to set up various settings. If you are curious, you can find a manual of all those settings here
Plane: The plane that acts as a simple “floor” in this scene.

Setting an ODIN access key

Info

As we want to keep things simple, you can generate an access key right from Unity. Expand the Client Authorization collapsible to reveal the authorization settings:

Click on the Manage Access . You’ll see a dialog like this:

Click on the Generate Access Key to generate an access key for free. This will allow you to connect with up to 25 users. Don’t use this access key in production!

Close the Access Key Manager window. Now you should see the access key set in the Client Authorization inspector.

Warning

Running the sample

Congratulations. Let’s test the sample scene. Press the Play button in the Unity Editor. You should see something like this:

You can drag & drop the Player cube with your mouse to position it somewhere else on the scene. That will become important later to experience 3D audio.

As always with voice chat, it’s boring if you are alone. So let’s get some other guys in the room.

Building the project

To get in more users, we’ll need to build the project, so we can share the binary with friends or colleagues. Open the build settings window by navigation to the menu File -> Build Settings.

Click on the Add Open Scenes button to add the current scene to the list.

Warning

Click on the Build and Run button to build the current scene and running it on your own machine. You’ll need to provide a folder on your hard disk where the binary will be created.

Navigate to the menu Edit -> Project Settings. The Project Settings Window will appear. Choose Player Settings on the left side and expand the Resolution and Presentation collapsible.

Testing ODIN

Ok, now that we optimized our app settings, let’s build and run the app again. Choose File -> Build and Run. The app should run in windowed mode now.

Now, get back into the Unity Editor and click on Play.

If you say something, you’ll hear your own voice. Now, begin to drag & drop the cubes around and notice how the direction changes depending on the relative position each cube has to each other.

You can send the binary to your friend or colleague to test ODIN in a more realistic scenario.

Warning

How does it work?

Congratulations, you now have a working example of ODIN integrated with 3D audio. Let’s have a deeper look at it to understand how everything works.

ODIN is a client-server solution, which means that ODIN clients, i.e. applications built with Unity
or the Unity Editor itself, are connecting to ODIN servers and joining rooms. Every client connected to the same room
can listen to all audio streams of the other clients connected to a room. Every client may send audio in the room,
but does not have to. They may be muted or may just listen to the audio streams (e.g. spectators).

With ODIN, you can replicate both variants, or even mix them. There is only one setting in Unity that makes the whole difference: spatialBlend available in AudioSource .

ODIN is deeply integrated into the game engine instead of being a layer above. ODIN therefore uses core Unity technology:

AudioListener : This is the players ear within the scene. The position of the GameObject is important if you are using 3D spatial (positional) audio. Typically, this is attached to the player GameObject or the camera if you are not using 3D audio for voice.
AudioSource : An AudioSource in Unity acts as the ‘speaker’ that generates sound within the scene. The AudioSource component has a setting called spatialBlend , which determines whether the sound is spatial (3D) or non-spatial (2D). If you want the sound to be part of the 3D environment (i.e., affected by the object’s position relative to the listener), set spatialBlend to 1.0. On the other hand, if you want the sound to be heard at a constant volume regardless of the object’s position (e.g., for sounds like collecting a coin), set it to 0.0.

graph LR;
    subgraph Unity Scene
        subgraph Player1 [Player 1]
            PBC1[PlaybackComponent]-->GO1[GameObject]                   
        end
        subgraph Player2 [Player 2]
            PBC2[PlaybackComponent]-->GO2[GameObject]
        end
        
    end
    subgraph ODIN Server
        subgraph ODIN Room
            Peer1[Peer 1] --> Media11[Media 1]--> PBC1
            Peer2[Peer 2] --> Media21[Media 2]--> PBC2
        end    
    end    
    classDef blue fill:#DDFAFF
    class Player1,Player2 blue

To build this hierarchy we need to listen to certain events and handle them. Don’t worry, it’s super easy and just requires a couple lines of code.

In the next section we’ll have a closer look at how this is done:

The ODIN Manager Object

The first object that we’ll have a closer look is the OdinManager 3D Variant object. You already know this Game Object as you used it to set up your access key.

If you look closer, you’ll notice there are a couple of scripts attached to this GameObject:

Odin Editor Config: The Odin Editor Config script allows you to set up ODIN within your game and handles client authorization and is part of the ODIN SDK.
Odin Handler: This script does all the event handling and exposes various settings for the microphone and audio effects. See the manual of Odin Handler for a documentation of all the settings available and how to use the API. This class is also part of the ODIN SDK.
Microphone Reader: This class is part of the ODIN SDK and captures the audio input from the microphone connected to the players PC and sends it to ODIN servers once the client joined an ODIN room. See the Microphone Reader for more info on this component.
Simple Push To Talk: This script is part of the sample code and uses the ODIN SDK to implements joining a room and “Push to Talk” (i.e. the microphone is always muted, and you need to press a button to unmute while talking). We’ll have a closer look at this script in the next paragraph.

Simple Push To Talk

Let’s have a look at the SimplePushToTalk.cs script provided with the sample. It uses various APIs provided by the ODIN SDK to join a room and to implement push to talk logic.

Basic Push to Talk

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

using OdinNative.Unity.Audio;

namespace OdinNative.Unity.Samples
{
    public class SimplePushToTalk : MonoBehaviour
    {
        public string RoomName;
        [SerializeField]
        public KeyCode PushToTalkHotkey;
        public bool UsePushToTalk = true;
        public MicrophoneReader AudioSender;

        private void Reset()
        {
            RoomName = "default";
            PushToTalkHotkey = KeyCode.C;
            UsePushToTalk = true;
        }

        // Start is called before the first frame update
        void Start()
        {
            if (AudioSender == null)
                AudioSender = FindObjectOfType<MicrophoneReader>();

            OdinHandler.Instance.JoinRoom(RoomName);
        }

        // Update is called once per frame
        void Update()
        {
            if (AudioSender)
                AudioSender.RedirectCapturedAudio = UsePushToTalk ? Input.GetKey(PushToTalkHotkey) : true;
        }
    }
}

Info

The Player Object

The second Game Object, that we want to take a close look at is the Player object in the scene. Select it, and you’ll notice a couple of scripts attached to this object:

Audio Listener: In many games, the audio listener is attached to the camera. In this case, we want the player’s “ears” to be positioned at the player’s location, which is important because we want Unity to calculate audio from other sources relative to the player’s position, not the stationary camera above the scene. Please note that the AudioListener is a standard Unity component.
Drag Object: This is just a simple script that allows you to drag & drop the cube. We won’t go into detail on how this is implemented, but feel free to have a look at the script in your preferred IDE.
Odin 3d Trigger: This script handles some ODIN events and creates the peer cubes. We’ll dive into this script in a minute.

Odin 3d Trigger

The Odin3dTrigger.cs script is handling a couple of ODIN events and creates the peers whenever a peer connects. It’s a bit longer, so we go through it step, by step.

Handling events

void Start()
{
    OdinHandler.Instance.OnCreatedMediaObject.AddListener(Instance_OnCreatedMediaObject);
    OdinHandler.Instance.OnDeleteMediaObject.AddListener(Instance_OnDeleteMediaObject);
    OdinHandler.Instance.OnRoomLeft.AddListener(Instance_OnRoomLeft);

    var SelfData = OdinHandler.Instance.GetUserData();
    //Set Player
    GameObject player = GameObject.FindGameObjectsWithTag("Player").FirstOrDefault();
    if (player != null)
    {
        TextMesh label = player.GetComponentInChildren<TextMesh>();
        label.text = CustomUserDataJsonFormat.FromUserData(SelfData)?.name ?? player.name;
    }
}

So, we listen to the OnCreatedMediaObject , OnDeleteMediaObject and OnRoomLeft events:

OnCreatedMediaObject: Triggered whenever a peer started sending audio data
OnDeleteMediaObject: Triggered whenever a peer stopped sending audio data
OnRoomLeft: Triggered when a peer left a room.

We also get the User Data of the user and set the text label of the player object to the player name (if available).

Now, as you can see, we need to have some callback methods for these events, let’s have a look step by step:

Handling On Media Created Events

The OnMediaAdded implementation

GameObject CreateObject()
{
    return Instantiate(prefab, new Vector3(0, 0.5f, 6), Quaternion.identity);
}

private void Instance_OnCreatedMediaObject(string roomName, ulong peerId, int mediaId)
{
    Room room = OdinHandler.Instance.Rooms[roomName];
    if (room == null || room.Self == null || room.Self.Id == peerId) return;

    var peerContainer = CreateObject();

    //Add PlaybackComponent to new dummy PeerCube
    PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(peerContainer, room.Config.Name, peerId, mediaId);

    //Some AudioSource test settings
    playback.PlaybackSource.spatialBlend = 1.0f;
    playback.PlaybackSource.rolloffMode = AudioRolloffMode.Linear;
    playback.PlaybackSource.minDistance = 1;
    playback.PlaybackSource.maxDistance = 10;

    //set dummy PeerCube label
    var data = CustomUserDataJsonFormat.FromUserData(room.RemotePeers[peerId]?.UserData);
    playback.gameObject.GetComponentInChildren<TextMesh>().text = data == null ?
        $"Peer {peerId} (Media {mediaId})" :
        $"{data.name} (Peer {peerId} Media {mediaId})";

    PeersObjects.Add(playback.gameObject);
}

This callback does four things:

Instantiate a peer cube (from the peer prefab) which represents the peer in the scene as a cube with the CreateObject function.
Attach the audio source for that peer to the instantiated peer GameObject. ODIN SDK provides a function AddPlaybackComponent for that. It creates a PlaybackComponent and attached it to the peer cube GameObject. The function also returns the PlaybackComponent instance so that we can customize it in the next step.
The PlaybackComponent uses a Unity AudioSource for “sending” audio into the scene. You can get your hands to that audio source using the PlaybackSource property. In this sample, the spatialBlend value is set to 1.0 to activate 3D spatial audio for peers and a couple of other settings like the volume attenuation is set.
Use the User Data of the peer to get its name and set the label of that peer to that name. This allows us to identify the peers in the scene.

Some experiments

Let’s do some experiments with the sample that we have right now to showcase the power of ODIN and to give you an idea what you can do with it in your game.

Switching to “gods voice”

Change the line where spatialBlend is set into this:

Disabling 3D audio

playback.PlaybackSource.spatialBlend = 0.0f; //Disable 3D audio

Please note, that spatialBlend is a float value. You can also set it to 0.5f to have something in between.

Adjusting voice attenuation

Setting voice attenuation

playback.PlaybackSource.minDistance = 1;
playback.PlaybackSource.maxDistance = 2;

Summary

1	ODIN SDK	Install the ODIN SDK into your project.
2	Add ODIN Manager	Drag & Drop the ODIN Manager Prefab into your scene.
3	Access Key	Create and set an access key in the Unity inspector.
4	Handle ODIN events	Handle some ODIN events like shown above or described in the Event Handling guide and use AddPlaybackComponent to create the other players audio sources and attaching them to player objects in your scene.

Next steps

Now that you have a working example find out more about the components ODIN has to offer.

Read our Event Handling guide to learn which events you need to implement. It shows an example of basic walkie-talkie like voice combined with 3D positional audio.
Check out the Unity manual with more info on the components and what the various settings are for.
Check out the API Reference with a comprehensive documentation on all classes and interfaces exposed by the ODIN SDK.
Follow our guide on how to add Unity to a Mirror Networking based multiplayer game. After 20 minutes you’ll have a fully working multiplayer game with 3D positional voice chat and synced player positions
In our Photon open-source sample you can download and play around with a working example based on Photon Pun.

`}),e.add({id:3518,href:"https://www.4players.io/4netplayers/requirements/",title:"Prerequisites",section:"Free Server Hosting",description:"A list of prerequisites that your dedicated server software must meet to be added to our library",content:`

4Netplayers is a very flexible platform. Today, more than 300 games are available in our library. However, while our operations team can add most server software, there are some no-gos that prevent servers to be added.

In this documentation we guide you through those requirements and give some hints how to achieve that in favorite game engines.

Must haves

Your dedicated server software must meet these requirements:

Windows or Linux binary
Must run headless (i.e. no GUI or any form of human input required)
Command line option to set the port and IP address of the game server.
Server queries to retrieve status information

The requirements in detail:

Windows or Linux binary

The binary should run on Window Server or on Linux (Ubuntu). It can be a x86 or x64 binary. However, as of today, we do not support ARM builds.

If you are building a server using Mirror Networking or Photon or MLAPI, you can export a headless dedicated server via the Build Settings in Unity. If possible, always choose Linux binary, as we prefer Linux binaries.

In Unity 2021.1 and later, the Build Settings look a bit different and you can choose Dedicated Server as a build target on the left side. In earlier versions, you need to choose Linux or Windows build and then activate the checkbox “Headless” in the options on the right side to activate a headless server build.

In Unreal you need to package your dedicated server in the Menu File > Package Project > Build Target. Follow this guide on how to build a dedicated server for your game.

Headless

It’s important that your binary does not require opens any form of GUI. If you follow the official guides for Unity and Unreal on how to build a dedicated server that is not an issue. But in the past we noticed some developers that added crazy things on their dedicated servers.

Always remember, that server starting and stopping is a fully automated process. If your dedicated server requires mouse or key input, we will not be able to add it. Also remember, that the game servers are running in data centers on server hardware that does not have a graphics card installed. Your dedicated server may not need any form of graphical output!

IP and Port settings

Most dedicated servers are binding 0.0.0.0 or INADDR_ANY. That means, that the software will pick the first IP available on a machine. In our platform, gameservers might be running on the same physical hardware which might have many different IP addresses linked. We need to make sure, that the gameserver is binding on the IP address and port that we need. As the gameserver is linked to a customer account, and our customers may choose to have a dedicated IP address we need to be able to set that IP address when launching the server. We also need to make sure that there are no port collisions and therefore need to be able to set port and ip address via command line.

Please provide these command line options (or something similar):

Option	Example	Description
-port P	-port 27015	The option to set the port of the server
-ip IP	-port 162.162.162.162	An option to assign the ip address the server is binding
-numslots S	-numslots 16	The maximum number of users that may connect to the server

Your server should bind on the port and the IP address given via command line parameter. If no IP is given, bind on 0.0.0.0 or INADDR_ANY.

Server queries

Sometimes, gameservers crash. Or more users connect to the server as allowed. To prevent these cases, the server must deliver at least a heart beat query that we can use to figure out, if the server is running and everything is fine. If the query does not ping back, the server is restarted automatically.

You can use Steam to build server queries that are used by many games and make it very easy for us to implement these games into our library: Steam Server Queries.

There should be at least one server query returning these info on request:

Number of players currently connected
Number of maximum players that may connect
Name of the server

General Guidelines

These are general guidelines that we have compiled over the years.

Configuration Files

Remember that dedicated servers should run without any input from users. Therefore, many dedicated servers allow customization of the gaming experience with one or more config files.

4Netplayers customers can customize and setup their server with a simple to use web interface. There, we offer two modes: Basic Mode and Advanced Mode.

Basic Mode

In this mode, customers get a nice list of options and easy to understand controls like a “switch” to enable or disable features.

Our operations team reverse builds a structure from the config file and our parsers and generators automatically generate a config file when the server is about to be started.

Advanced Mode

In advanced mode, customers are allowed to edit the config files directly in an editor provided in the web interface. Therefore it’s important that the config files are easy to understand. Use variables that make sense and allow external users to easily understand what this setting does. Add comments to the template (that we also add to the config files) so that it’s even easier to understand.

Config file formats

The config files that you use for your dedicated server should follow these simple rules. Then it’s easy for our operation team to create great basic config options, and the community can create great gameservers in advanced mode without requiring external documentation.

Must be text format (binary formats are a no-go, because they are nearly impossible to parse by other services)
Use XML, JSON, plain text or INI files.
YAML files should not be used as the syntax is not easy to understand and very error-prone.
Use good naming of variables
Provide a config file with all default values
Add comments for each option and provide information about minimum and maximum values and what they do

Admins

Provide a config file (i.e. admins.ini) where customers can setup admins for the server that have the authority to kick users. That is an important part for owners of a server. Owning a server also means they can control every aspect of the server - especially who is playing on the server.

Databases

Use file based databases like SQLLite instead of server based databases like MySQL or MariaDB. SQLLite does not require any config or setup, which makes it easy for your users and our operations team to handle them.

If you want multiple servers to connect to one database then you may offer both options (SQLLite and a server based) and let users decide in a config option which one to use. Default should be file based database as most customers only rent one server.

Next steps

Ready to go? Does your server meet the requirements?

`}),e.add({id:3519,href:"https://www.4players.io/odin/guides/unity/",title:"Unity",section:"ODIN Documentation",description:"Discover how to integrate 4Players ODIN into your Unity projects with our step-by-step guides and tutorials. Learn the basics of event handling, and explore integration with Mirror Networking and Photon PUN 2 for multiplayer gaming with 3D positional audio. Get started today and unlock the power of ODIN for your Unity games.",content:`

4Players ODIN is deeply integrated into Unity and supports all major platforms. A couple of components are enough to add real-time voice communication to your game in no time. Please note, that ODIN requires Unity 2019.4 or any later version. We also support Apple Silicon, however right now this only works with the latest Unity version with native Apple Silicon support.

Getting Started

We have compiled a couple of Getting Started Guides to get you started quickly.

Unity video tutorial series

Watch our Unity video tutorial series

Written guides

Getting started with ODIN

Follow this guide to install ODIN in an empty Unity project. We’ll try out one of the samples that come with ODIN and explain how it works and which steps are required to implement ODIN into your own game.

Event Handling

Implementing ODIN is simple, but you need to handle three events for most implementations. Check out our Event handling guide to learn more about basic event handling based on a real-world use-case complete with example code.

ODIN and Mirror Networking

ODIN is best suited to be added to a multiplayer game. In this guide, we’ll create a basic multiplayer with 3D positional audio based on Mirror Networking. You’ll also learn how to leverage ODIN APIs like user data.

ODIN and Photon PUN 2

In this guide, you’ll learn how we integrated ODIN into our multiplayer Tech-Demo, utilizing Photon PUN 2 for multiplayer synchronization. The Tech-Demo demonstrates the full range of capabilities offered by the ODIN Unity SDK, providing a comprehensive example for developers looking to implement real-time multiplayer functionality.

Getting Started with ODIN

General Guides

A couple of concepts apply to all game engines and platforms and it’s important to understand those, especially when going into production.

Understanding Access Keys is an important part later when moving your game to production. Read this guide to understand how we use access keys and how they work in detail.

`}),e.add({id:3520,href:"https://www.4players.io/fleet/manual/registries/aws/",title:"Adding an AWS Elastic Container Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect an AWS Elastic Container Registry (ECR) to ODIN Fleet, supporting both private and public repositories.",content:`

To link your AWS Elastic Container Registry (ECR) with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “AWS” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your AWS ECR:

Name: Enter a name for this registry connection.
Registry URL: Depending on whether you’re connecting to a private or public repository, use the following formats:
- Private Repositories: https://<aws_account_id>.dkr.ecr.<region>.amazonaws.com
  - Example: https://802596915135.dkr.ecr.eu-central-1.amazonaws.com
- Public Repositories: https://public.ecr.aws/<registry_alias>
  - Example: https://public.ecr.aws/r7e4l4q2
Access Key: Your AWS Access Key associated with the IAM user who has the required permissions.
Secret Access Key: The Secret Access Key corresponding to the above Access Key.

Authentication and Access Permissions

For authenticating with AWS ECR, you’ll need an IAM user with the appropriate permissions. Here’s how to set up access:

Create an IAM User with ECR Permissions:
- In AWS IAM, create a user group named “ECR” and assign the following policies:
  - AmazonEC2ContainerRegistryFullAccess
  - AmazonElasticContainerRegistryPublicFullAccess
- Add your IAM user (e.g., b2b) to this group.
- Generate an Access Key and Secret Access Key for this user.
Use the Access Keys:
- The Access Key and Secret Access Key will be required in the ODIN Fleet setup to authenticate and access your repositories.

Automatic Detection

ODIN Fleet automatically detects whether the registry is public or private based on the URL format you provide. The URL is validated upon entry, and an exception is thrown if it doesn’t match the expected format.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now pull images from your AWS ECR directly within ODIN Fleet.

Additional Resources

`}),e.add({id:3521,href:"https://www.4players.io/fleet/manual/registries/",title:"Adding Registries",section:"ODIN Fleet Documentation",description:"Learn how to connect docker registries to ODIN fleet.",content:`

ODIN Fleet allows you to seamlessly integrate various Docker registries into your deployment workflow. By linking your preferred registries, you can efficiently manage container images, automate deployments, and streamline the process of scaling your applications. This section will guide you through the steps required to add different types of Docker registries to ODIN Fleet, including well-known providers like Docker Hub, GitLab, GitHub, Azure, AWS, and custom self-hosted registries.

Each registry type has specific configuration requirements, so make sure to follow the relevant instructions for the registry you wish to add. The links below will take you to detailed guides for each supported registry.

Supported Registries

Docker Hub: Connect private repositories on Docker Hub, the world’s most popular container registry. Learn how to integrate Docker Hub with ODIN Fleet.
GitLab: Integrate your GitLab container registry, supporting both GitLab.com (cloud version) and self-hosted GitLab instances, for managing and deploying container images. Learn how to set up GitLab integration.
GitHub: Link ODIN Fleet with GitHub Container Registry, enabling the use of private repositories, organization-level repositories, and public images hosted on GitHub. Learn how to configure GitHub with ODIN Fleet.
Google Cloud: Connect to your Google Cloud Container Registry. [Learn how to add a self-hosted registry] (/google-cloud).
Azure: Utilize Azure Container Registry (ACR) to manage container images within the Microsoft Azure ecosystem, perfect for cloud-native applications on Azure. Learn how to add Azure Container Registry.
AWS: Integrate AWS Elastic Container Registry (ECR) to leverage secure, scalable container image management within your AWS infrastructure. Learn how to connect AWS ECR to ODIN Fleet.
Self-Hosted Registries: Connect to custom or self-hosted Docker registries, providing flexibility for private, on-premises, or specialized environments. Learn how to add a self-hosted registry.
Custom: For registries not explicitly supported by ODIN Fleet, you can use the Custom option to manually configure the connection. Learn how to add a custom registry.

`}),e.add({id:3522,href:"https://www.4players.io/fleet/cli/apps/",title:"Apps",section:"ODIN Fleet Documentation",description:"Learn how to work with ODIN Fleet apps using the CLI.",content:`

Apps are the primary building blocks of ODIN. They represent a project or application that you are working on. Each app contains a set of resources, such as devices, users, and data streams, that you can interact with using the ODIN CLI.

You may create up to 100 apps in your account. Each app has a unique ID that is used to identify it in the ODIN system.

Overview

The apps commands allow you to manage apps in your account. Before executing any other commands, you must select an app to work with using the odin apps select command.

The selected app is stored in the configuration file on your system and is used for subsequent commands. The configuration file also stores your API key, which you can set using the odin login command.

Usage

odin apps <command>

Commands

List: List all apps in your account.
Select: Select an app to use for subsequent commands.
Get: Display detailed information about an app.
Create: Create a new app.
Delete: Delete an app.

`}),e.add({id:3523,href:"https://www.4players.io/fleet/cli/fleet/servers/backups/",title:"Backup persistent server data",section:"ODIN Fleet Documentation",description:"Create a backup of a server to protect your data.",content:`

If you have defined persistent data for your server, you can create a backup of the data to protect it from accidental loss. Backups are stored securely and can be restored at any time. You can also download a backup to your local machine for safekeeping or to run a local copy of your server for testing.

Overview

The backup command allows you to create a backup of a server in your account. Backups are created from all folders defined as persistent data in the server configuration. You can create a backup of a server at any time.

Please note

When you create a backup, the server will be paused for a short time while the backup is created. This will cause a brief interruption in service for your players. The same is true when you restore a backup. At the moment only one backup can be created at a time. The latest backup will overwrite the previous one.

Creating a backup

To create a backup of a server, use the following command:

odin fleet servers backup create [--server-id=<server-id>] [--name=<name>]

Flags

--server-id: The ID of the server to create a backup for. If not provided, you will be prompted to select a server.
--name: The name of the backup. If not provided, you will be prompted to enter a name.

Restoring a backup

To restore a backup of a server, use the following command:

odin fleet servers backup restore [--server-id=<server-id>]

Flags

--server-id: The ID of the server to restore a backup for. If not provided, you will be prompted to select a server.

Downloading a backup

To download a backup of a server, use the following command to receive a download link:

odin fleet servers backup download-url [--server-id=<server-id>]

You will receive a download link as a text that you can use to download the backup to your local machine.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3524,href:"https://www.4players.io/odin/introduction/structure/",title:"Basic Concepts",section:"ODIN Documentation",description:"Learn about ODINs basic concepts",content:`

ODIN is a client server platform. Servers are hosted by 4Players, but can also be hosted by clients. The whole system is stateless and scalable. There are no databases keeping track of everything, instead everything just relies on stateless connections and some tokens that are used during authentication.

Info

In the following diagrams we use these words frequently.

Local: For the local client (i.e. you as a developer testing your current build)
Server: The ODIN server hosted by 4Players or hosted by yourself on your own infrastructure or the cloud
Remote: All other clients connected to the same server/room, i.e. your colleagues.

Topology

This diagram outlines the basic structure of two clients connected to an ODIN server. Client 1 has joined two rooms listening and talking and Client 2 has also joined room 2 but is just listening there.

graph TB;
    subgraph ODIN Server
        Connection1[Connection 1]
        Connection2[Connection 2]
    end
    Client1[Client 1] -- Authenticate --> Connection1
    Client2[Client 2] -- Authenticate --> Connection2
    subgraph Room1[Room 1]
        Peer11[Peer 1] -- StartMedia --> MediaStream111[Media Stream 1]
    end
    subgraph Room2[Room 2]
        Peer21[Peer 1] -- StartMedia --> MediaStream211[Media Stream 1]
        Peer21[Peer 1] -- StartMedia --> MediaStream212[Media Stream 2]
        Peer22[Peer 2]
    end    
    Connection1 -- JoinRoom --> Peer11
    Connection1 -- JoinRoom --> Peer21
    Connection2 -- JoinRoom --> Peer22

Every client connects an ODIN server and authenticates with an access token and joins a room. Once the client has joined a room, he is a peer inside the ODIN room. Every peer can add media to that room, linked to a physical device like a microphone. Clients can join multiple rooms at the same time and can add multiple media streams at the same time.

Important

ODIN rooms work independently of each other. This means that each client is a different peer in every room, having a different peer id. Also, you cannot use the same media stream for multiple rooms at once, but you have to create a new one for each room.

Info

Every peer receives the media streams of the other peers connected to the same room, but are not required to add their own media. Spectators will want to listen but not talking themselves. A muted peer for example also does not have a media.

Connecting to Server

The first step is to connect to a server and a room. If you are using one of our high level SDKs like Unity or Unreal joining a room is all you have to do. The SDK handles authentication and server connection for you.

sequenceDiagram

participant Local
participant Server
participant Remote

Local ->>+ Server: Authenticate
Server -->>- Local: Success

Local ->>+ Server: JoinRoom
Server ->> Remote: PeerJoined
Server -->>- Local: Success

Local --> Server: Opening Room Stream
Server ->> Local: Joined

Once the connection is established and the room has joined an event is sent to all other peers in the same room: PeerJoined. This allows you to update your UI for example like showing a list of peers that are within a room.

The client who joined the room will receive a RoomJoin and RoomJoined event. If a user clicks a button to join a room, you can use the RoomJoin event to start showing a loading indicator and hiding it once RoomJoined has been triggered.

Event summary

Local	Remote	Description
OnRoomJoin		Triggered if user started to join a room
OnRoomJoined	OnPeerJoined	Triggered if user joined a room

ODIN does not require any bookkeeping. A room is created automatically for the first connection and will be removed whenever the last user left the room. You join a room by calling the JoinRoom method of the OdinHandler instance in your scene.

class MyVoiceHandler: MonoBehaviour
{
  public string RoomName = "default";
  
  // Start is called before the first frame update
  void Start()
  {
    OdinHandler.Instance.JoinRoom(RoomName);
  }
}

Local	Remote	Description
On Room Joined	On Peer Joined	Triggered if user joined a room

Info

Please note: To join a room you need to create an access token. The whole process is described in the Unreal Engine Manual.

Joining a room looks like this:

Event handling looks like this:

Starting a media

As defined above, every peer connected to a room can (but does not have to) add a media, i.e. a stream connected to the peers’ input device, e.g. a microphone. Please note: Every peer can add multiple media to the same room (i.e. audio and video). In Contrary, you can not use the same media twice, e.g. for 2 different rooms.

sequenceDiagram

participant Local
participant Server
participant Remote

Local ->>+ Server: AddMedia
Server ->> Remote: MediaAdded
Server -->>- Local: Success

The local OdinHandler will trigger OnCreatedMediaObject once the request media has been added to the server. OnMediaAdded is triggered for media added by other peers to the room.

Event summary

Local	Remote	Description
OnCreatedMediaObject	OnMediaAdded	Triggered once the media has been added to the room on the server

Info

It’s important to handle the OnMediaAdded callbacks. Whenever you receive this event, you need to call the AddPlaybackComponent method on your OdinHandler instance which will create a PlaybackComponent and assign to a GameObject that corresponds to this peer in Odin.

Local	Remote	Description
On Add Media To Room Success	On Media Added	Triggered once the media has been added to the room on the server

Info

It’s important to handle the On Media Added event. Whenever you receive this event, you need to assign the media to an Odin Synth Component that is either part of the asset (added at design time) or you can also create that component with Add Odin Synth Component in your blueprint. The Odin Synth Component generates audio output from the incoming media stream.

Adding a media looks like this:

Stopping a media

Users can mute their audio streams, in this case, the media stream should be stopped, so that no data is captured and to ODIN servers. Of course, also leaving a room can lead to stopped media.

sequenceDiagram

participant Local
participant Server
participant Remote

Local ->>+ Server: StopMedia
Server ->> Remote: MediaStopped
Server -->>- Local: Success

The MediaStopped event will be triggered once the request media has been deleted on the server.

Event summary

Local	Remote	Description
OnDeleteMediaObject	OnMediaRemoved	Triggered once the media has been added to the room on the server

Info

It’s important to handle the OnMediaRemoved callbacks as it’s up to you to remove the PlaybackComponent from the corresponding GameObject that you used initially when adding the PlaybackComponent in the OnMediaAdded callback.

Updating Peer User Data

Every peer in Unity can store arbitrary information as user data. When local user data is updated, the server updates user data at all clients and sends this message. Read more about user data in our guide: Understanding User Data.

sequenceDiagram

participant Local
participant Server
participant Remote

Local ->>+ Server: UpdateUserData
Server ->> Remote: PeerUpdated
Server -->>- Local: Success

Whenever a peer updates his data, all other peers receive the PeerUpdated event to handle the new data.

Event summary

Local	Remote	Description
OnPeerUserDataChanged	OnPeerUserDataChanged	Triggered once for every updated peer user data

Sending Arbitrary Data

You can use ODIN to send arbitrary data to other clients. You can use this method to build simple multiplayer games that don’t require complex, real-time movement. For many casual games or board games, this message is enough to sync the players positions and other information of the game state with all clients.

The data you can send is basically just an array of bytes. You can use any data serialization that makes sense to you. Many game engines already provide data serialization features.

Warning

Note: You will only receive the MessageReceived event if your own peer ID was in the list of recipients.

sequenceDiagram

participant Local
participant Server
participant Remote

Local ->>+ Server: SendMessage
Server ->> Remote: MessageReceived
Server -->>- Local: Success

Event Summary

Local	Remote	Description
OnMessageReceived	OnMessageReceived	Triggered after receiving a message

Disconnecting

If peers disconnect other peers will be notified with the PeerLeft events.

sequenceDiagram

participant Local
participant Server
participant Remote

Local -->+ Server: Closing Connection
Server ->> Remote: PeerLeft
deactivate Server

Event Summary

Local	Remote	Description
OnRoomLeave		Triggered if user started to leave a room
OnRoomLeft	OnPeerLeft	Triggered if user left a room

Getting Kicked

If a peer is kicked from the server, this message flow will take place:

sequenceDiagram

participant Local
participant Server
participant Remote

activate Server
Server ->> Local: Left
Server ->> Remote: PeerLeft
Server --> Local: Closing Connection
deactivate Server

Event Summary

Local	Remote	Description
OnRoomLeft	OnPeerLeft	Triggered if user has been kicked from a room

Local	Remote	Description
-	On Peer Left	Triggered if user left a room

Next Steps

Curious enough? Then get started with our Getting Started Guides. Choose your platform and start coding. It’ll only take 20 minutes to play around with ODIN right in your game engines editor: Getting Started.

Still not convinced or wanting to learn more? We have compiled a couple of use cases and how ODIN is best suited to handle them perfectely, being it a First Person Shooter or a MMO Battle Royal Game.

Next: Use Cases

`}),e.add({id:3525,href:"https://www.4players.io/fleet/cli/fleet/configs/",title:"Configs",section:"ODIN Fleet Documentation",description:"Manage configuration files in your account.",content:`

Configs in Fleet define how your images are configured when they are deployed. There are many options available to customize your deployments, such as environment variables, volumes, and ports. It’s easier to manage these configurations using our dashboard, but you can also manage them using the CLI.

Overview

The configs commands allow you to manage configurations in your account. You can create new configurations, list existing configurations, and delete configurations that are no longer needed.

Usage

odin fleet configs <command>

Commands

List: List all configurations in your account.
Get: Display detailed information about a configuration.
Create: Create a new configuration.
Delete: Delete a configuration.
Update: Update a configuration

`}),e.add({id:3526,href:"https://www.4players.io/fleet/cli/fleet/configs/create/",title:"Create a configuration",section:"ODIN Fleet Documentation",description:"Create a new configuration.",content:`

Creates a new configuration for a specified app. A configuration defines the settings for a deployment, such as the image to use, environment variables, persistent folders and the ports to expose.

Configs are quite complex objects, so we recommend using the dashboard to create and manage them. However, you can also create and manage them using the CLI.

This command can be used in two ways:

Interactive mode: Run the command without any flags to be prompted for the required information. Use the --dry-run flag to see the JSON payload that would be sent to the API without actually creating the configuration.
Non-interactive mode: Use the --payload flag to specify a JSON payload to create the configuration.

Usage

odin fleet configs create [--payload=JSON_PAYLOAD] [--dry-run]

Examples

Create a new configuration interactively and see the JSON payload that would be sent to the API:

odin fleet configs create --dry-run

This will output the JSON payload that would be sent to the API. You can use this payload to create the configuration with the --payload flag:

odin fleet configs create --payload='{"name":"My Config...."}' --force

This is useful for automation of server configuration creation. You can interactively create a configuration or create a configuration in the dashboard and use the Get command to get the JSON payload using the --format=json flag. Then use a tool like jq to modify the payload and create a new configuration using the --payload flag.

Flags

If you want to create a configuration interactively, you can run the command without any flags. The CLI will prompt you for the required information.

--dry-run:
An optional flag that shows the JSON payload that would be sent to the API without actually creating the configuration. You can use that payload to create the configuration with the --payload flag.
--payload=<string>:
An optional flag that allows you to specify a JSON payload to create the configuration. This is useful for non-interactive mode and if you want to create a configuration with a specific configuration.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3527,href:"https://www.4players.io/fleet/cli/fleet/deployments/create/",title:"Create a deployment",section:"ODIN Fleet Documentation",description:"Create a new deployment.",content:`

Creates a new deployment for a specified app. A deployment defines which server configurations (and therefore which images) are being deployed at which location and with how many instances.

Please note

We have a flexible system of selecting locations. In your deployment you provide a country and a city. The system will automatically select the best location for you based on the available locations in the selected country and city.

Usage

odin fleet deployments create [--name=IMAGE_NAME] [--deployment-id=DEPLOYMENT_ID][--num-instances= NUM_INSTANCES] [--country=COUNTRY] [--city=CITY] [payload=JSON_PAYLOAD] [--dry-run]

Examples

Create a new deployment interactively:

odin fleet deployments create

Create a new deployment with a specific configuration:

odin fleet deployments create --name="US-NYC-Community-Servers" --config-id=123456 --num-instances=5 --country=us 
--city=newyork

Flags

If you want to create a deployment interactively, you can run the command without any flags. The CLI will prompt you for the required information.

--dry-run:
An optional flag that shows the JSON payload that would be sent to the API without actually creating the image. You can use that payload to create the image with the --payload flag.
--payload=<string>:
An optional flag that allows you to specify a JSON payload to create the image. This is useful for non-interactive mode and if you want to create an image with a specific configuration.

Instead of providing a JSON payload, you can use the following options to create an image:

--name=<string>:
The name of the image. This is a required option to identify the image.
--config-id=<number>:
The ID of the configuration that should be used for the deployment.
--num-instances=<number>:
The number of instances that should be deployed.
--country=<string>:
The country where the deployment should be created.
--city=<string>:
The city where the deployment should be created.

Info

Use the odin fleet locations command to get a list of available locations.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3528,href:"https://www.4players.io/fleet/cli/apps/create/",title:"Create an App",section:"ODIN Fleet Documentation",description:"Create a new app.",content:`

Creates a new app with the specified name and options. If you don’t provide a name, the CLI will prompt you to enter one.

Info

There are no costs involved in creating an app. You only pay for the resources you use (like servers, images, etc.).

Usage

odin apps create [--name=APP_NAME]

Examples

Create a new app with the name my-app:

odin apps create --name="my-app"

Flags

--name=<string>:
The name of the app to create.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3529,href:"https://www.4players.io/fleet/cli/fleet/images/create/",title:"Create an Image",section:"ODIN Fleet Documentation",description:"Create a new server image.",content:`

Creates a new image for use in deployments. There are many options available for creating an image, allowing you to customize settings such as the Docker image, registry, and Steamworks integration.

Info

If you provide your own docker images you need to register a registry within ODIN Fleet. You can do this in the console. More info can be found in our Adding Registries Guide in the Manual. You will need the ID of the registry to register a docker image with ODIN Fleet. If you want to use Steamworks images, you need to provide the Steam App ID of the game or tool you want to use.

Usage

odin fleet images create [--name=IMAGE_NAME] [--version=IMAGE_VERSION] [--os=IMAGE_OS] [--type=IMAGE_TYPE] [--docker-image=DOCKER_IMAGE] [--registry-id=REGISTRY_ID] [--steam-app-id=STEAM_APP_ID] [--branch=STEAM_BRANCH] [--password=STEAM_PASSWORD] [--command=STEAM_COMMAND] [--steamcmd-username=STEAMCMD_USERNAME] [--steamcmd-password=STEAMCMD_PASSWORD] [--runtime=STEAM_RUNTIME] [--headful] [--request-license] [--unpublished] [payload=JSON_PAYLOAD] [--dry-run]

Flags

If you want to create an image interactively, you can run the command without any flags. The CLI will prompt you for the required information.

--dry-run:
An optional flag that shows the JSON payload that would be sent to the API without actually creating the image. You can use that payload to create the image with the --payload flag.
--payload=<string>:
An optional flag that allows you to specify a JSON payload to create the image. This is useful for non-interactive mode and if you want to create an image with a specific configuration.

Instead of providing a JSON payload, you can use the following options to create an image:

--name=<string>:
The name of the image. This is a required option to identify the image.
--version=<string>:
Specifies the version of the image. This can be useful for managing different iterations of the same image.
--os=<string>:
Defines the operating system that the image is based on. For example, it could be linux, windows, etc.
--type=<string>:
Specifies the type of the image. This is either dockerImage or steam.

These options need to be provided to create a docker image (i.e. --type=dockerImage):

--docker-image=<string>:
The name of the Docker image to use. This should be the full path to the Docker image in the registry.
--registry-id=<number>:
The ID of the Docker registry where the image is stored. This is useful if you have multiple Docker registries configured. You can get the registry ID in the console https://console.4players.io/settings/docker-registries

Provide these options to create a Steam image (i.e. --type=steam):

--steam-app-id=<number>:
The Steam App ID associated with the image. This is required if the image is related to a Steam application.
--branch=<string>:
Specifies the Steam branch to use. This allows you to choose between different branches (e.g., beta, stable) of a Steam game or application.
--password=<string>:
The password associated with the Steam branch, if required. This is typically used for private or protected branches.
--command=<string>:
Specifies a command to be run by Steam, useful for custom deployment scripts or specific launch commands.
--steamcmd-username=<string>:
The username for SteamCMD. Required for downloading and managing Steam games or tools via the command line.
--steamcmd-password=<string>:
The password for SteamCMD. This is used in conjunction with the SteamCMD username to authenticate and perform operations.
--runtime=<string>:
Specifies the Steam runtime environment. This might be necessary for games or applications that require a specific runtime version.
--headful:
An optional flag that enables Steam in headful mode, where a graphical interface might be needed for certain operations.
--request-license:
An optional flag to request a Steam license, usually needed for restricted or license-protected games.
--unpublished:
If your Steam app is not published, you need to set this flag, otherwise leave it out.

Examples

You can use the --format flag to customize the output format. For example, to just display/get the image ID you can use the --format="value(id)" flag.

odin fleet images create --name=<image_name> --type=dockerImage --docker-image=<docker_image> --registry-id=<registry_id> --format="value(id)"

This is useful for bash scripts or other automation tasks, where you want to use the ID of the created image in the next command. A full example could look like this:

IMAGE_ID=$(
  odin fleet images create \\
  --name="Example Image" \\
  --type="dockerImage" \\
  --docker-image="example/example-image:latest" \\    
  --registry-id=1 \\
  --force \\
  --format="value(id)")
  
echo "Created image with ID: $IMAGE_ID"

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3530,href:"https://www.4players.io/fleet/cli/fleet/configs/delete/",title:"Delete a Config",section:"ODIN Fleet Documentation",description:"Delete a config by ID.",content:`

Deletes the specified config.

Warning

Deleting a config is irreversible and will remove all associated resources like deployments and servers. Without using the --force flag, the CLI will prompt you to confirm the deletion.

Usage

odin fleet configs delete [--config-id=CONFIG_ID]

Flags

--config-id=<number>:
The ID of the config to delete. If omitted, the CLI will prompt you to enter the config ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3531,href:"https://www.4players.io/fleet/cli/fleet/deployments/delete/",title:"Delete a Deployment",section:"ODIN Fleet Documentation",description:"Delete a deployment by ID.",content:`

Deletes the specified deployment.

Warning

Deleting a deployment is irreversible and will remove all associated servers. Without using the --force flag, the CLI will prompt you to confirm the deletion.

Usage

odin fleet deployments delete [--deployment-id=DEPLOYMENT_ID]

Flags

--deployment-id=<number>:
The ID of the deployment to delete. If omitted, the CLI will prompt you to enter the config ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3532,href:"https://www.4players.io/fleet/cli/apps/delete/",title:"Delete an App",section:"ODIN Fleet Documentation",description:"Delete an app by ID.",content:`

Deletes the specified app.

Warning

Deleting an app is irreversible and will remove all associated resources like images, configs, deployments and servers. Without using the --force flag, the CLI will prompt you to confirm the deletion.

Usage

odin apps delete [-app-id=APP_ID]

Flags

--app-id=<number>:
The ID of the app to delete. If omitted, the CLI will prompt you to enter the app ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3533,href:"https://www.4players.io/fleet/cli/fleet/images/delete/",title:"Delete an Image",section:"ODIN Fleet Documentation",description:"Delete an image by ID.",content:`

Deletes the specified image.

Warning

Deleting an image is irreversible and will remove all associated resources like deployments and servers. Without using the --force flag, the CLI will prompt you to confirm the deletion.

Usage

odin fleet images delete [--image-id=IMAGE_ID]

Flags

--image-id=<number>:
The ID of the image to delete. If omitted, the CLI will prompt you to enter the image ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3534,href:"https://www.4players.io/fleet/cli/apps/get/",title:"Get App Details",section:"ODIN Fleet Documentation",description:"Retrieve an app by ID.",content:`

Fetch details for a specific app by ID.

Usage

odin apps get [--app-id=APP_ID]

Examples

Retrieve details for an app by ID as a JSON object:

odin apps get --app-id=app-123456 --format=json

Flags

--app-id=<string>:
The ID of the app to retrieve details for. If omitted, the CLI will prompt you to enter the app ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3535,href:"https://www.4players.io/fleet/cli/fleet/configs/get/",title:"Get Config Details",section:"ODIN Fleet Documentation",description:"Display detailed information about a configuration.",content:`

Retrieves details of a specific configuration.

Usage

odin fleet configs get [--config-id=CONFIG_ID]

Examples

Retrieve details for a configuration by ID as a JSON object:

odin fleet configs get --config-id=123456 --format=json

Flags

--config-id=<number>:
The ID of the configuration to retrieve details for. If omitted, the CLI will prompt you to enter the configuration ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3536,href:"https://www.4players.io/fleet/cli/fleet/deployments/get/",title:"Get Deployment Details",section:"ODIN Fleet Documentation",description:"Display detailed information about a deployment.",content:`

Retrieves details of a specific deployment.

Usage

odin fleet deployments get [--deployment-id=DELPOYMENT_ID]

Examples

Retrieve details for a deployment by ID as a JSON object:

odin fleet deployments get --deployment-id=123456 --format=json

Flags

--deployment-id=<number>:
The ID of the deployment to retrieve details for. If omitted, the CLI will prompt you to select the deployment interactively from a list of deployments.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3537,href:"https://www.4players.io/fleet/cli/fleet/images/get/",title:"Get Image Details",section:"ODIN Fleet Documentation",description:"Display detailed information about an image.",content:`

Retrieves details of a specific image.

Usage

odin fleet images get [--image-id=IMAGE_ID]

Examples

Retrieve details for an image by ID as a JSON object:

odin fleet images get --image-id=123456 --format=json

Flags

--image-id=<number>:
The ID of the image to retrieve details for. If omitted, the CLI will prompt you to enter the image ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3538,href:"https://www.4players.io/fleet/cli/fleet/servers/get/",title:"Get Server Details",section:"ODIN Fleet Documentation",description:"Display detailed information about a server.",content:`

Retrieves details of a specific server.

Usage

odin fleet servers get [--server-id=SERVER_ID]

Examples

Retrieve details for an image by ID as a JSON object:

odin fleet servers get --server-id=123456 --format=json

Get IP address and published Game Port of the server. In this example we have defined a port named Game Port in the configuration:

odin fleet servers get --server-id=123456 --format="value[separator=':'](addr,ports['Game Port'].publishedPort)"

We use the separator attribute here to separate the IP address and the port with a colon instead of the default tab. This can be useful for creating a list of servers to use in a script or for monitoring.

Flags

--server-id=<number>:
The ID of the image to retrieve details for. If omitted, the CLI will prompt you to enter the image ID interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3539,href:"https://www.4players.io/4netplayers/getting-started/",title:"Getting Started",section:"Free Server Hosting",description:"A quick guide on how to add your game to our library",content:`

This document will guide you through the onboarding of your game into our library. Our operations team will be there to help, of course.

1. Join Discord Server

The best place to communicate with our operations team and sales is our discord channel. Please join us here:

2. Confirm prerequisites

There are a couple of prerequisites that must be met before we can add the dedicated server of your game into our library. If you use typical multiplayer frameworks like Photon, Mirror Networking, MLAPI for Unity or Unreal Engine then you typically already meet these requirements. However, please check out our documentation on that topic and make sure your dedicated server software meets those requirements:

Validate Prerequisites

3. Upload binaries

You need to upload the server software somewhere that we have access to. Best way to do that is to leverage CI/CD with Github actions, Unity cloud build or Gitlab that will automatically test, compile, build and deploy your latest server build on this folder. This way, you don’t need to worry about us getting the latest build. Just commit to master or set a tag (depending on your CI/CD rules) and the new server build will be available at the URL you provide.

4. Provide information

Compile a document (PDF, Google Docs, website or something similar) and provide this information:

URL of the binaries and access information if held private
Available command line options (please note that a few are a requirement on our side)
Example of a command line with all arguments
Explanation of config file locations
Description of config file options and minimum and maximum values (if not available as comments in the config file template itself)
Files or folders that need to be backed up as they store persistent data of the server
Artwork and/or packshot of your game for our landing pages and web interface (can also be a URL where we can download them)

That’s it

Once you have joined our Discord server and provided the information above, our operations team will add your game to our library and will provide you with access to our web interface where you can setup and launch your gameservers to validate and verify that everything works as intended.

We’ll also create a store page at 4Netplayers.com where your community will be able to purchase their own server with ease.

Info

Our backend regularly checks the URL for new binaries and if available will automatically update the software in our library and will trigger restarts of all running servers (as long as users have not disabled automatic restarts).

Read on if you want to learn more about hosting official servers or getting revenue shares selling servers directly in your game. This is optionally and if you just want to have your servers made available to the 4Netplayers community and your customers for quickly getting full-service gameservers then that’s ok for us!

Official Servers

If you want or need official servers for your game, we got you covered. You can either rent a fleet of game servers from us (contact sales) or 4Players will provide the fleet for free if you sign a contract that guarantees exclusivity (contact sales).

We provide revenue shares if customers purchase a server coming directly from your game. Just add a button to your main menu or server list “Get your own server” and route users to the landing page of your game on our store page (i.e. Valheim or [Minecraft] (https://www.4netplayers.com/en/server-hosting/minecraft-server-rental/?ckq=true) with a special partner id added to the URL. This way we can track sales through your game and you’ll receive 0,18€ per slot/month running on servers that you have advertised in your game.

(Contact sales) if your are interested in this type of business model. We strongly recommend doing it:

Gamers will have official servers to play on to get started playing your game
Once they want to have their own server they can just rent them for fair prices from us
You may provide the server to your community without any hosting services but it’s ok for us if they host servers on their own root servers or VMs.
Instead of getting charged for your game servers, you’ll get paid from us for letting us hosting them with 0,18€ per slot and month.

`}),e.add({id:3540,href:"https://www.4players.io/fleet/cli/apps/list/",title:"List available Apps",section:"ODIN Fleet Documentation",description:"List all apps in your account.",content:`

Displays a list of all available apps. The currently selected app is highlighted (if output formatting supports it).

Usage

odin apps list

Examples

List all apps in a table format:

odin apps list

List all apps and display the output in JSON format:

odin apps list --format=json

Flags

--filter:
An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3541,href:"https://www.4players.io/fleet/cli/fleet/configs/list/",title:"List available Configs",section:"ODIN Fleet Documentation",description:"List all configurations in your account.",content:`

Lists all configurations in your account. Configurations define how your images are configured when they are deployed. There are many options available to customize your deployments, such as environment variables, volumes, and ports. It’s easier to manage these configurations using our dashboard, but you can also manage them using the CLI.

Usage

odin fleet configs list [--unused]

Examples

List all configs in a table format:

odin fleet configs list

List the ids of unused configs (useful for cleanup):

odin fleet configs --format="value(id)" --unused

List the configs that match a specific name pattern:

odin fleet configs --format="table(id,name)" --filter="name ~ 'Minecraft*'"

Flags

--unused:
An optional flag that filters the list to show only images that are not currently in use by any deployments.
--filter:
An optional flag that filters the list of configurations. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3542,href:"https://www.4players.io/fleet/cli/fleet/deployments/list/",title:"List available Deployments",section:"ODIN Fleet Documentation",description:"List all deployments in your account.",content:`

Lists all deployments in your account. Deployments define which server configurations (and therefore which images) are being deployed at which location and with how many instances.

Usage

odin fleet deployments list

Examples

List all deployments in a table format:

odin fleet deployments list

Create a JSON file with the list of deployments:

odin fleet deployments list --format=json > deployments.json

List the deployments running in a specific location:

odin fleet deployments list --filter="placement.constraints.country = 'us'"

Flags

--filter:
An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3543,href:"https://www.4players.io/fleet/cli/fleet/images/list/",title:"List available Images",section:"ODIN Fleet Documentation",description:"List all images of the selected or specified app.",content:`

Lists all server images available in the selected or specified app. Images can either be docker images provided by you or you can also link to a Steam App ID.

Usage

odin fleet images list [--unused]

Examples

List all images in a table format:

odin fleet images list --format="table(id,name,type)"

List the ids of unused images (useful for cleanup):

odin fleet images list --format="value(id)" --unused

List images that are being processed or have failed:

odin fleet images list --filter="status != 'ready'"

Flags

--unused:
An optional flag that filters the list to show only images that are not currently in use by any deployments.
--filter:
An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3544,href:"https://www.4players.io/fleet/cli/fleet/servers/list/",title:"List running servers",section:"ODIN Fleet Documentation",description:"List all deployed servers in your account.",content:`

Lists all servers that are running for your app. You cannot modify servers directly using the CLI, but you can view information about them. To modify servers, you need to change the underlying deployment or configuration.

Usage

odin fleet servers list

Examples

List all servers in a table format:

odin fleet servers list

If you have defined an environment variable in the underlying configuration named SERVER_NAME you can use this command show a table of servers with the SERVER_NAME column:

odin fleet servers list --format="table(id,addr,env['SERVER_NAME'].value)"

Return a list of servers that are either ready and have a specific name, or have a specific ID:

odin fleet servers list --filter="(serverConfig.status = 'ready' AND serverConfig.name = 'Minecraft Production 2') OR id = 211"

Let’s create a CSV list with IP addresses, published game port (defined in the configuration with name Game Port), and the server name (defined in the configuration with name SERVER_NAME):

odin fleet servers list --format="value[separator=';'](addr,ports['Game Port'].publishedPort,env['SERVER_NAME'].value)"

This can be useful for creating a list of servers to use in a script or for monitoring.

Info

If you find this confusing please read the manual page on server configurations. There we go into detail about how to setup environment variables and ports.

Flags

--filter:
An optional flag that filters the list of deployments. The filter expression follows a straightforward structure of <field> <operator> <value>. The field can be any property in the dataset, and operators include basic comparison operators such as =, !=, >, <, >=, and <=. Filters can also be combined using logical operators AND, OR, and negated with NOT. You can access nested fields using dot notation, and strings should be enclosed in quotes. Learn more about filters in our filters documentation.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3545,href:"https://www.4players.io/fleet/cli/fleet/servers/restart/",title:"Restart a Server",section:"ODIN Fleet Documentation",description:"Restart a server.",content:`

You can restart servers at any time. If the underlying server configuration has persistent data, the data will be preserved across restarts. If the server is part of a deployment, the server will be restarted with the same configuration as the deployment.

Usage

odin fleet servers restart [--server-id=SERVER_ID]

Examples

Restart a server by ID:

odin fleet servers restart --server-id=123456

Flags

--server-id=<number>:
The ID of the server to restart. If omitted, the CLI will prompt you to select a server from a list

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3546,href:"https://www.4players.io/fleet/cli/apps/select/",title:"Select an App",section:"ODIN Fleet Documentation",description:"Select an app to use for subsequent commands.",content:`

Select an app to use for subsequent commands. This is required before executing certain commands (if not provided via the --app-id parameter).

Usage

odin apps select [--app-id=APP_ID]

Examples

Select an app interactively:

odin apps select

Select a specific app via the command line:

odin apps select --app-id=app-123456

Flags

--app-id=<string>:
The ID of the app to select. If omitted, the CLI will prompt you to select an app interactively.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3547,href:"https://www.4players.io/fleet/cli/fleet/servers/logs/",title:"Show Server Logs",section:"ODIN Fleet Documentation",description:"Display detailed server logs",content:`

Retrieves logs of the server which can be useful for debugging and monitoring.

Usage

odin fleet servers logs [--server-id=SERVER_ID] [--details=DETAILS] [--follow=FOLLOW] [--stdout=STDOUT] [--stderr=STDERR] [--since=SINCE] [--timestamps] [--tail=TAIL]

Warning

This command does not support the --format flag. Output is always in text format.

Examples

Retrieve details for an image by ID as a JSON object:

odin fleet servers logs --server-id=123456

Show logs of the last hour with timestamps and only error messages:

odin fleet servers logs --server-id=123456 --since=60 --timestamps=true --stderr=true --stdout=false

Flags

--server-id=<number>:
The ID of the image to retrieve details for. If omitted, the CLI will prompt you to enter the image ID interactively.
--details:
Show detailed logs if true, otherwise show only the log message.
--follow:
Follow logs if true.
--stdout:
Show stdout logs. Default is true.
--stderr:
Show stderr logs. Default is true.
--since=<string>:
Only return logs newer than a relative duration like 30, 180. Default is all logs.
--timestamps:
Show timestamps
--tail=<string>:
Number of lines to show from the end of the logs. Use all to show all logs.

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3548,href:"https://www.4players.io/rooms/getting-started/sign-up/",title:"Sign Up",section:"Rooms Documentation",description:"Learn how to create an account with ODIN Rooms and get started with secure, decentralized video conferencing.",content:`

Signing up for ODIN Rooms is quick and easy and is a two or three-step process, depending on whether you are want to use the free version or a paid version.

Configure Your Tier

The first step is to configure your account. After choosing a tier on our landing page, you will be prompted to enter the following information:

Subdomain

You will be prompted to enter a subdomain. This subdomain is the unique web address where your video conferencing service will be accessible. For example, if you choose “talk” as your subdomain, your ODIN Room will be available at talk.rooms.chat.

Your subdomain must be a combination of letters and numbers (starting with a letter).
This is how participants will access your meetings, so choose a name that reflects your use.

Number of Slots

By default, you can host up to 20 participants simultaneously in as many rooms as you like. This option is perfect for small businesses and personal use. You can scale up by adjusting the number of slots as needed.

Free for Small Businesses and Personal Use

For up to 20 participants, Rooms is completely free of charge. This plan is ideal for small businesses, NGOs, educational institutions, and personal use.

Rental Duration

Choose the rental duration that best fits your needs. The default option is 1 month, but you can save 10% by selecting a 12-month plan.

Once you have completed these steps, proceed to checkout to finalize your account and start using Rooms!

Create Your Account

Pressing Next will take you to the account creation page. Here, you will be prompted to enter your email address and create a password. You will also need to enter your address and payment information if you have chosen a paid plan.

Setting Up Your Rooms

It may take a couple of minutes for your account and Rooms instance to be set up. Once it is ready, you will receive an email with a link to your Rooms instance. Click the link to access your Rooms and start collaborating securely!

If you entered talk as the subdomain during sign-up your Rooms instance will be available at talk.rooms.chat. Once you received the email that your Rooms instance is ready, enter your domain into your browsers address bar. In our example it would be https://talk.rooms.chat.

If you open your Rooms instance for the first time, you will be prompted to setup some basic settings. Pressing the (i) icon in the middle of the screen will reveal some details about Rooms, including the version number and the terms. You’ll also notice a sun (or moon) icon. This is the light/dark mode switch. You can toggle between light and dark mode by clicking on it.

The first step is to setup your Rooms Title and the Server Location.

App Title and Server Location

App Title: This is the name of your Rooms instance. It will be displayed in the browser tab and will be the name if someone bookmarks your Rooms instance.
Server Region: Choose the region where your Rooms instance is hosted. This will ensure the best performance for your participants.

Click “Continue” to proceed to the next step.

Branding

In this step, you can setup logos and backgrounds for your Rooms instance. You can also setup colors. You will need to setup for both light and dark mode.

Primary Color: This is the main color of your Rooms instance. It will be used for buttons and other elements.
Secondary Color: This color will be used for secondary elements.
Logo: Provide a URL to your logo. It will be displayed in the top left corner of your Rooms instance.
Background: Provide a URL to a background image. It will be displayed in the background of your Rooms instance.
Use as default: Activate this button to set the light or dark mode as default. I.e. if you activate this toggle when in the light mode settings, the light mode will be the default mode.

Logo and Background

The logo and background image must be hosted on a server that supports HTTPS. The image URLs must start with https://. We are working on allowing uploads of logos and backgrounds directly in the Rooms instance. This feature will be available in one of the next updates this fall (2024).

Click “Continue” to proceed to the next step.

Guest Permissions

In this step, you can setup permissions of guests for your Rooms instance. You can choose to allow or disallow certain features for guests.

Modify App Settings: Allow guests to modify the app settings (like changing the logo or background).
Mute Participants: Allow guests to mute other participants.
Poke Participants: Allow guests to poke other participants. Poking means that the participant will receive a notification which is useful if they are not paying attention or have muted their audio.
Enable Audio: Allow guests to enable or disable their microphone. Disabling that feature will mute the microphone of the guest.
Enable Video: Allow guests to enable or disable their camera. Disabling that feature will turn off the camera of the guest.
Clear Drawings: Allows guests to clear the whiteboard.
Clear Text Chat: Allows guests to clear the text chat.

You can change these settings at any time in the settings of your Rooms instance (if you have the necessary permissions).

Click “Continue” to proceed to the next step.

Owners Password

In the last step, you can setup a password for the owner of the Rooms instance. This password is needed to access the settings of the Rooms instance.

Owner Team Password: Enter a password for the owner of the Rooms instance. This password is needed to access the settings of the Rooms instance.
Owner Team Password (Repeat): Repeat the password to ensure it is correct.

Owner Password

As we want to have full GDPR compliance, we do not store any user data. As such, we don’t want to and cannot store user accounts and assign permissions to them. The owner password is the only way to access the settings of the Rooms instance and must be kept safe. If you lose the password, you need to reach out to our support team to reset your instance.

Click “Finish Setup” to complete the setup of your Rooms instance.

Next Steps

Now that you have set up your Rooms instance, you can start inviting participants to your meetings. Before that, we recommend checking out our Basic Concepts guide to learn more about the unique features of Rooms and how to use them effectively.

`}),e.add({id:3549,href:"https://www.4players.io/odin/guides/unreal/",title:"Unreal",section:"ODIN Documentation",description:"Explore our comprehensive guides to integrate ODIN's voice chat SDK with Unreal Engine 4 and 5. Get started quickly with our step-by-step tutorials and detailed blueprint references for a smoother gaming experience.",content:`

The SDK (UnrealEngine 4 and 5) is based on our C Api and can be downloaded from our Github repository:

Download Unreal Engine SDK

Prerequisites

Unreal Engine 4.26 or any later version (including 5.x)

Internally, the plugin is automatically built for compatibility starting from Unreal Engine 4.26 and is thoroughly tested with each new official release of Unreal Engine.

Getting Started

We have compiled a couple of Getting Started Guides to get you started quickly.

Unreal video tutorial series

Watch our Unreal video tutorial series

Written guides

Getting started with ODIN

Follow this guide to learn how to install and setup ODIN in your Unreal Project using Blueprint.

Blueprint Reference

Check out our extensive Blueprint reference to learn more about the nodes our SDK provides and how to connect them into your game.

General Guides

A couple of concepts apply to all game engines and platforms, and it’s important to understand those, especially when going into production.

Understanding Access Keys is an important part later when moving your game to production. Read this guide to understand how we use access keys and how they work in detail.

`}),e.add({id:3550,href:"https://www.4players.io/fleet/cli/fleet/configs/update/",title:"Update a Config",section:"ODIN Fleet Documentation",description:"Update a config by ID.",content:`

Updating a configuration allows you to change the settings of an existing configuration. This can be useful if you want to modify the configuration of a deployment without creating a new configuration.

Info

Updating a configuration that is used in a deployment will affect all deployments that use this configuration. This is a powerful tool as it allows you to update all running servers with a new image or configuration with one command.

Usage

odin fleet configs update [--name=IMAGE_NAME] [--command=COMMAND] [--args=ARGS] [--binary-id= BINARY_ID] [--restart-policy=RESTART_POLICY] [--memory=MEMORY] [--cpu=CPU] [--payload=JSON_PAYLOAD] [--dry-run]

Flags

The command will only update the fields that are provided. If you want to update multiple fields, you can provide them all in one command. You can also provide a JSON payload to update the configuration using the usual --payload flag. This command also support the --dry-run flag to see the JSON payload that would be sent to the API without actually updating the configuration.

--name=<string>:
The name of the configuration.
--command=<string>:
The command that should be executed when the server starts. It overwrites the command that is defined in the image.
--args=<string>:
The arguments that should be passed to the command when the server starts. It overwrites the arguments that are defined in the image.
--binary-id=<number>:
The ID of the binary that should be used for the server. By changing the binary, you can update all running servers of deployments linked to this configuration file.
--restart-policy=<string>:
The restart policy of the server. This can be always, on-failure, or any
--memory=<number>:
The amount of memory that should be allocated to the server in GB.
--cpu=<number>:
The amount of CPU that should be allocated to the server in cores.

Examples

Update the memory requirement of a configuration:

odin fleet configs update --config-id=123456 --memory=4

You can also update multiple fields at once:

odin fleet configs update --config-id=123456 --memory=4 --cpu=2

A usual use case is to update the underlying image of a configuration. This can be done by changing the binary ID of the configuration. In this more complex example, we create a new image, wait until the image is ready to be deployed and then update the configuration to use the new image which will restart all servers with the new image.

It can be used in CI/CD pipelines to update the image of a configuration and restart all servers with the new image.

#!/bin/bash

# Define the variables
IMAGE_NAME="Minecraft Java 21"
IMAGE_VERSION="1.0.1"
OS_TYPE="linux"
DOCKER_IMAGE="itzg/minecraft-server:java21"
REGISTRY_ID=1
CONFIG_ID=16

# Create a new image and get its ID
IMAGE_ID=$(./odin fleet images create \\
    --name="$IMAGE_NAME" \\
    --version="$IMAGE_VERSION" \\
    --os="$OS_TYPE" \\
    --type="steam" \\
    --docker-image="$DOCKER_IMAGE" \\
    --registry-id=$REGISTRY_ID \\
    --format="value(id)" \\
    --force)

echo "Created image with ID: $IMAGE_ID"

# Monitor the image status until it's ready
STATUS="processing"
while [[ "$STATUS" != "ready" ]]; do
    STATUS=$(./odin fleet images get --image-id=$IMAGE_ID --format="value(status)")
    echo "Current status of image $IMAGE_ID: $STATUS"

    # Check if the status is 'error', in which case we should exit with a failure
    if [[ "$STATUS" == "error" ]]; then
        echo "Error: Image creation failed. Exiting."
        exit 1
    fi

    # Wait for a few seconds before polling again
    sleep 5
done

echo "Image $IMAGE_ID is ready."

# Update the config with the new image ID
./odin fleet configs update --config-id=$CONFIG_ID --binary-id=$IMAGE_ID --force

echo "Config $CONFIG_ID has been updated to use image $IMAGE_ID."

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3551,href:"https://www.4players.io/fleet/cli/fleet/deployments/update/",title:"Update a Deployment",section:"ODIN Fleet Documentation",description:"Update a deployment by ID.",content:`

A deployment defines which server configuration runs with how many instances at a specific location. You can update a deployment to change the number of instances or the configuration that is used thus updating all running server instances with just one command.

This is also how you start and stop servers - you don’t babysit individual servers, you update the deployment and the system takes care of the rest.

For example, if you have a deployment with 10 instances and you update the configuration, all 10 instances will be restarted with the new configuration. Reducing the number of instances to 8 will stop 2 instances and reduce the number of running servers to 8. Increasing the number of instances to 12 will start 4 new instances with the selected configuration.

Info

You have two options to update servers: In either case you need to create a new image of your updated server binaries. Then you can either create a new configuration with the new image and update the deployment to use the new configuration or you can update the configuration directly with the new image. The latter will update all deployments that use this configuration.

Usage

odin fleet deployments update [--name=IMAGE_NAME] [--num-instances=NUM_INSTANCES] [--deployment-id=DEPLOYMENT_ID] [--payload=JSON_PAYLOAD] [--dry-run]

Flags

--name=<string>:
The name of the configuration.
--num-instances=<number>:
The number of instances that should be running with this configuration.
--deployment-id=<number>:
The ID of the deployment that should be updated. Omitd if you want to choose deployment interactively.
--payload=<string>:
An optional flag that allows you to specify a JSON payload to update the deployment. This is useful for non-interactive mode and if you want to update a deployment with a specific configuration.
--dry-run:
An optional flag that shows the JSON payload that would be sent to the API without actually updating the deployment. You can use that payload to update the deployment with the --payload flag.

Examples

Increase the number of deployments by 4:

DEPLOYMENT_ID=123456
NUM_INSTANCES=$(odin fleet deployments get --deployment-id=$DEPLOYMENT_ID --format="value(numInstances)")
NUM_INSTANCES=$((NUM_INSTANCES + 4))
odin fleet deployments update --deployment-id=123456 --num-instances=$NUM_INSTANCES --force

Global Flags

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3552,href:"https://www.4players.io/rooms/manual/user-interface/",title:"User Interface",section:"Rooms Documentation",description:"Explore the ODIN Rooms user interface and learn how to navigate the platform.",content:`

In this guide we’ll explore the user interface of ODIN Rooms. We’ll show you how to navigate the platform and how to use the different elements that are part of the user interface.

After joining a room (see Your first Call), you will see the following user interface:

Let’s navigate through the UI:

(1) Main Area: This is the main area of the room. Here you see the video of the other participants, the chat, the whiteboard and other elements that are part of the room.
(2) User Info: Your user info is displayed in the top right corner including your name and your avatar. Pressing on the three dots will open a menu where you can change your name, your avatar, your status and toggle light/dark mode.
(3) Participant: Each user connected to the room is displayed in the participant list (5) on the right side. You can see their name, their status and their avatar. You can also see if they have audio or video enabled. By pressing on the three dots, additional options are available.
(4) Area Controls: These controls are used to control what is displayed in the area (see below for more details on this)
(5) Participants: On the sideboard on the right side you see the participants that are currently in the room. You can see their name, their status and their avatar. You can also see if they have audio or video enabled.
(6) Dock: The dock allows you to mute, activate or disable video, share your screen, view notifications and open the settings.
(7) Sidebar (Left): The sidebar allows you to dock additional modules like the text chat. The sidebar can be opened and closed by the Area Controls (3). More on this later.
(8) Switch: This button switches the content of the main area with the sidebar. This way, you can have the main area for video and the sidebar for chat or whiteboard - or the other way around.

Area Controls

The area controls (3) allow you to control what is displayed in the main area. You can switch between the video, the chat, the whiteboard and other modules that are part of the room. From top to bottom, these buttons are available:

Maximize Sidebar: The first button maximizes the sidebar. This is useful if you want to focus on the chat or the whiteboard that is typically pinned on the left side. Pressing the button again will minimize the sidebar.
Minimize Participant List: The next button makes space for the sidebar and main area by minimizing the participant list. Instead of the full list of participants, you will only see the avatars of the participants. Pressing the button again will bring back the usual participant list.
Video Chat/Text Chat: In the main area, show the video of the participants or the text chat. Depending on what is displayed in the sidebar (see above), you can switch between the video and the chat.
Whiteboard: In the main area, show the whiteboard. The whiteboard is a shared canvas where you can draw, write or add images. You can use the whiteboard for brainstorming, presentations or just for fun.

Switching the Area

The typical layout is to have the text chat on the left side in the sidebar and the video in the main area. You can switch this by clicking on the “Switch” button (7). This will move the sidebar to the main area and the video to the sidebar. This is useful if you want to focus on the chat or the whiteboard.

Dock

In the dock (5) you have the following controls:

Mute: This button mutes your microphone. If you are muted, the button has a red cross over it.
Output: This button mutes your speakers, i.e. after clicking that button you can’t hear the other participants anymore.
Video: This button activates or deactivates your camera. If your camera is deactivated, the button has a red cross over it.
Screen: This button allows you to share your screen. If you are sharing your screen, the button has a green checkmark over it.
Notifications: This button shows you the notifications that you have received. This can be a message in the chat, a poke or a notification from the system.
Settings: This button opens the settings dialog where you can change your audio and video settings.

Button States

All app designers face the same issue: How to make it clear to the user what a button does and what the state is. One way of doing it is to show an icon that reflects what will happen if you click that button. But this requires to think about what the current state, i.e. of the microphone is. We do it differently: Buttons always reflect the current state, i.e. if the microhone button is crossed, your microphone is muted, clicking the button will activate it. If the button is not crossed, your microphone is active.

Participant List

In the participant list (5) you see the participants that are currently in the room. You can see their name, their status and their avatar. You can also see if they have audio or video enabled. By pressing on the three dots, additional options are available:

Volume: You can adjust the volume of the participant. This is useful if the participant is too loud or too quiet.
Poke: Sometimes you want to get the attention of a participant. You can poke them. This will send a notification to the participant.
Add to favorites: If you have a lot of participants in the room, you can add them to your favorites. Favorite users will be displayed at the top of the participant list and will always be visible in the video area.
Mute Microphone: You can mute the microphone of the participant. This is useful if the participant has a lot of background noise or if they are not aware that their microphone is active. You need to have the necessary permissions to mute other participants. See permissions for more details.

User Info

In the top right corner you see your user info. This includes your name and your avatar. Pressing on the three dots will open a menu where you can change your name, your avatar, your status and toggle light/dark mode.

Display Name: You can change your display name. This is the name that is displayed to other participants in the room.
Custom Status: You can set a custom status. This is useful if you want to show others what you are currently doing or if you want to give them a hint on what you are interested in.
Use Dark Mode: You can toggle between light and dark mode. This is useful if you are in a dark environment and want to reduce the brightness of the screen.

The icon at the outermost right corner of the user info is the “Leave Room” Button. Pressing this button will leave the room and close the connection to the server. You can rejoin using the same URL or by entering the room name anytime.

Video Area

In the video module, you see the video of the participants or cards of participants with their initials. The bottom of each video cards has two buttons:

Fullscreen: This button allows you to switch the video to fullscreen mode. This is useful if you want to focus on the video of a specific participant (i.e. especially if they share the screen).
Options: This button opens a menu with additional options. You can mute the participant, poke them, add them to your favorites or adjust the volume.

Video Only

Please note, that the fullscreen button is only available if the participant has video enabled. It does not make sense to switch to fullscreen if the participant has no video enabled.

Clicking on the options button will open a menu with the following options:

These options are the same as in the right side participant list:

Volume: You can adjust the volume of the participant. This is useful if the participant is too loud or too quiet.
Poke: Sometimes you want to get the attention of a participant. You can poke them. This will send a notification to the participant.
Add to favorites: If you have a lot of participants in the room, you can add them to your favorites. Favorite users will be displayed at the top of the participant list and will always be visible in the video area.
Mute Microphone: You can mute the microphone of the participant. This is useful if the participant has a lot of background noise or if they are not aware that their microphone is active. You need to have the necessary permissions to mute other participants. See permissions for more details.

Clicking the options button again will close the options dialog for this participant.

Next Steps

You should now be familiar with the user interface of ODIN Rooms. Learn more about additional features in our manual:

Permissions: Learn how to manage permissions in your room.
Whiteboard: Discover how to use the whiteboard for brainstorming and presentations.
Text-Chat: Explore the text-chat module and learn how to communicate with other

`}),e.add({id:3553,href:"https://www.4players.io/rooms/getting-started/concepts/",title:"Basic Concepts",section:"Rooms Documentation",description:"Rooms is different from other video conferencing platforms. Learn what makes it unique and how to use it.",content:`

Teams, Zoom and many other video conferencing solutions are centralized and require you to create an account, download software, and trust a third party with your data. ODIN Rooms is different. It is a fully decentralized, browser-based video conferencing solution that offers robust end-to-end encryption, no need for accounts or downloads, and full control over your data.

How ODIN Rooms Works

During the pandemic, many people used video conferencing solutions to stay connected with friends, family, and colleagues. However, the basic model that has evolved over the years is that you setup a meeting for a specific time and invite people to join. With external partners and customers this is the best to do it. But with your team, your friends and family the concept is outdated and does not make much sense.

Many people got exhausted by the constant stream of meetings and the need to be available at a specific time. Even if you just wanted to clarify a small question, you had to setup a meeting, invite people and wait for them to join. This is where ODIN Rooms comes in.

The basic ODIN Rooms concept is that you have a room that is always open. You can join the room whenever you want and you can invite people to join you. You can use the room for a quick chat, a brainstorming session, a meeting or just to hang out. You can use the room for a few minutes or for a few hours. You can use the room for a one-on-one conversation or for a group meeting. You can use the room for a video call, a voice call or just for chatting. You can use the room for a presentation, a whiteboard session or just to share your screen. You can use the room for a game, a quiz or just to have fun.

This concept is more flexible and more natural than the traditional video conferencing model. It is more like a virtual office with rooms for different purposes. You can use the rooms for work, for learning, for socializing or just for fun. If you want to reach out to a specific team, just join their room. If you want to have a private conversation, just create a new room. If you want to have a meeting with a customer, just invite them to your room. If you want to have a party, just open a room and invite your friends.

Technical Details

Rooms is powered by ODIN Voice, our real-time voice chat SDK renowned for its low latency and crystal-clear audio, and powered by ODIN Fleet, our server hosting solution that provides global scalability and high availability. If you are interested in learning more about ODIN Voice and ODIN Fleet, check out the ODIN Voice and ODIN Fleet documentation.

How to Use ODIN Rooms

You just enter the name of a room, this can be something like coffee-break, we-hate-to-eat-alone, lets-play-a-game or devs, marketing or whatever comes into your mind. If you want to have a private conversation, just use a name that is hard to guess, like FE12-GH23-AB45.

If the room does not exist, it will be created and you will be the first person in the room. If the room already exists, you will join the room and see the other people that are in the room. You can invite people to join you by sharing the room name with them. You can also create a link to the room and share this link with others. The link is basically just this format: https://{subdomain}.rooms.chat/{room-name}, so if your instance is talk.rooms.chat and your room is coffee-break, the link would be https://talk.rooms.chat/coffee-break. That’s all you need to give to others to join your room. They just open the link in their Browser, optionally enter their name and join the room.

No Account Required

You don’t need to create an account to use ODIN Rooms. You don’t need to download any software. You don’t need to trust a third party with your data. You just open a link in your Browser and you are in the room. You can use ODIN Rooms completely anonymously. You can use ODIN Rooms without giving away any personal information.

Next Steps

Now that we have covered the basic concepts of ODIN Rooms, you are ready to start using the platform. Follow the next guide to learn how to do your first call with ODIN Rooms.

`}),e.add({id:3554,href:"https://www.4players.io/fleet/manual/images/",title:"Creating Images",section:"ODIN Fleet Documentation",description:"Learn more about creating and managing images in ODIN Fleet.",content:`

Docker images are ideal for running applications in containers. They are a lightweight, standalone, executable package that includes everything needed to run a piece of software, including the code, a runtime, libraries, environment variables, and config files.

When you want to run a server in our system, you need to provide a Docker image that contains the server software and all the necessary files. With server configs you configure the image for your server. You can also use environment variables and config files to pass configuration data to the server.

Creating an Image

4Players Fleet

When you create an image, you need to go through our image creating wizard where you need to provide the following information:

Name: The name of the image. This is the name that you will use to reference the image in your server configuration.
Version: The version of the image. This can any string and is only used to differentiate between different versions of the same image within our Dashboard.
OS: The operating system that the image is based on. This can be Linux or Windows.

In the next step you need to decide what image type you want to use. These options are available:

Image from Registry: Use an image from a public or private registry. You need to provide the image name and the registry.
Steamworks: Let us create an image from files stored in your Steamworks account.

Depending on the image type you choose, you need to provide different information.

Image from Registry

When you already have a docker image available in a registry, you can use this option to create an image. You need to provide the following information:

Image: The path and name of the image within the registry. For example on the public Docker Hub registry, the image mygame/myserver would be mygame/myserver:latest.
Registry: The registry where the image is located. This can be Docker Hub, GitHub Container Registry, Gitlab Container Registry, or a custom registry.

The default option for Registry is public Docker Hub. This is not always what you want, especially if your server is not public (yet). You can register your own private registry directly in this editor by clicking on the (+) icon or you can go into the Settings and add a new registry there.

Please note: If your specific registry provider is not yet available please reach out to us and we will add it for you.

Steamworks

When you have your server files stored in your Steamworks account, you can use this option to create an image. You need to provide the following information:

Steam App ID: The Steam App ID of your game.

If you entered a correct Steam App ID the following fields will be available:

Branch: The Steam branch that you want to use. This can be public or a custom branch.
Executable Command: We need to know the command to start your server. This can be a simple command like /gameserver/server.exe or a more complex command with parameters like /gameserver/server.exe --port 7777 --debug=false --maps=/gameserver/maps. If you have created Launchers within Steam you can choose that from a list.

You need to provide your Steamworks credentials to download the files from Steamworks. You need to provide the following information:

Steamworks Username: The username of your Steamworks account.
Steamworks Password: The password of your Steamworks account.

Please note: Steam guard needs to be disabled for this account. If you have Steam Guard enabled, you need to disable it for the time of the image creation. We are working on a solution to support Steam Guard.

Additional options can be provided:

Headful: If you want to run the server in headful mode, i.e. a GUI window will be opened. For production servers, this should be disabled.
Request License: If you want to request a license for the image.

File Paths

What we do under the hood is that we download the files from Steamworks and create a Docker image from them. All files from Steamworks are stored in the /gameserver path within the container, so you need to make sure that if you refer to any files that you prefix the /gameserver path.

More background information on how Steamworks works under the hood can be found here: Steamworks image creation explained.

`}),e.add({id:3555,href:"https://www.4players.io/rooms/getting-started/",title:"Getting Started",section:"Rooms Documentation",description:"Explore our comprehensive Rooms guides for getting started and advanced usage.",content:`

Welcome to ODIN Rooms! Follow these steps to set up your video conferencing platform and start collaborating securely.

1. Sign Up for ODIN Rooms

Follow this guide to sign up your Rooms account and setting up your Rooms instance.

2. Basic Concepts

Rooms is different from other video conferencing platforms. Learn what makes it unique and how to use it.

3. Your first Call

Create a room and send an invite link to initiate your first call.

`}),e.add({id:3556,href:"https://www.4players.io/fleet/guides/",title:"Guides",section:"ODIN Fleet Documentation",description:"Explore our comprehensive ODIN Fleet guides for getting started and advanced usage.",content:`

With Project ODIN Fleet, 4Players provides a complete, out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers so they don’t need to spend valuable resources designing a comms solution or gameserver hosting on their own.

Check out these guides to get started with ODIN Fleet:

Getting started with ODIN Fleet

Follow this guide to deploy a Minecraft Server via ODIN Fleet to learn more about the basic concepts and how to deploy your own game servers.

ODIN Fleet CLI

Follow this guide to install our CLI tool to interact with ODIN Fleet from your command line.

Install CLI

`}),e.add({id:3557,href:"https://www.4players.io/odin/guides/",title:"Guides",section:"ODIN Documentation",description:"Explore our comprehensive ODIN guides for seamless game engine integration and advanced tutorials. Learn to integrate ODIN into Unity, Unreal Engine, or native client libraries with our step-by-step instructions. Dive into advanced topics like understanding access keys to ensure a smooth transition to production for your game.",content:`

With Project ODIN, 4Players provides a complete, out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers so they don’t need to spend valuable resources designing a comms solution on their own.

We offer deep game engine integration. It works with any multiplayer framework and also works for single player games (i.e. users can play for themselves but chat with other players).

Video tutorials

Would you rather watch a video than stepping though our written guides? Watch this Unreal video tutorial series

or watch this Unity video tutorial series

Want more? The next chapters will come soon!

Choose your platform

In the next steps you’ll integrate ODIN into an empty project to learn more about the integration and general concepts. Please choose your plattform to continue:

Unity

We’ll create a simple multiplayer game with 3D voice

Unreal Engine

We integrate ODIN into the FPS demo provided by Epic

Adding an AWS Elastic Container Registry

We also offer native client libraries that even work on the command line. We don’t have extensive documentation for that yet, but for those people still reading, a header file should be enough.

Advanced Guides

Understanding Access Keys is an important part later when moving your game to production. Read this guide to understand how we use access keys and how they work in detail.

`}),e.add({id:3558,href:"https://www.4players.io/fleet/manual/",title:"Manual",section:"ODIN Fleet Documentation",description:"Explore the ODIN Fleet manual to understand the concepts and features of the platform.",content:`

Welcome to the ODIN Fleet manual! Here you will find detailed information about the concepts and features of the ODIN Fleet platform. Whether you are a game developer, publisher, or server operator, this manual will help you understand how to use ODIN Fleet to deploy and manage your game servers.

Basic Flow

The basic flow of using ODIN Fleet involves the following steps:

1	Create Image	The first thing you need to do is to provide your server to the ODIN Fleet platform. This is done by creating a Docker image that contains your server software and all the necessary files. You can create an image from a public or private registry or use Steamworks to create an image from files stored in your Steamworks account and we will create the image automatically for you.
2	Create Configuration	Once you have created an image, you need to create a server configuration that defines how your server should run. This includes setting up ports, environment variables, and persistent folders, among other things. You can create multiple server configurations for the same image to run different types of servers. This is useful if you want to run multiple game modes or different versions of your game.
3	Create Deployment	After creating a server configuration, you need to create a deployment that specifies which server configuration to use and how many instances of the server to run. You can also set up auto-scaling rules to automatically scale the number of server instances based on the load.
4	Monitor & Manage	Once your deployment is up and running, you can monitor and manage your servers using the ODIN Fleet dashboard. You can view server logs, metrics, and events, as well as perform actions like restarting, stopping, or scaling your servers.

The manual is divided into the following sections:

Adding Registries

Adding an Azure Container Registry

Adding a Docker Hub Registry

Adding a GitHub Container Registry

Adding a GitLab Registry

Adding a Google Cloud Container Registry

Adding a Self-Hosted Docker Registry

Adding a Custom Docker Registry

Steamworks Integration

`}),e.add({id:3559,href:"https://www.4players.io/rooms/manual/text-chat/",title:"Text Chat",section:"Rooms Documentation",description:"Learn how to use the text chat in ODIN Rooms.",content:`

Rooms features an easy to use text-chat that also supports markdown. This allows you to communicate with your team members in a more structured way. You can also send images and use emojis in the chat.

Once you have joined a room, make sure that the text-chat is visible (per default that’s the case). If it is not visible, make sure to disable the maximum sidebar (use Area Controls to reveal the chat).

By clicking on the Switch Toggle you can toggle between the sidebar text-chat and the text-chat in the main area.

This looks like this:

Sending a message

To send a message, just enter your message into the text field and press the Enter key or click on the send button. The text-message may also contain emojis and markdown. You can use the following markdown elements:

Bold: **bold** or __bold__
Italic: *italic* or _italic_
Strikethrough: ~~strikethrough~~
Code: \`code\`
Inline Code: \`inline code\`

Multiline Messages

To send a multiline message, press Shift + Enter to create a new line.

Sending an image

Click on the image icon in the text field to upload an image. The image will hover above the send message text entry field and you can add additional text to the message if needed. Click on the send button or press Enter to send the message.

Image Upload

The image upload is limited to 10MB per image.

Persistant Chat

Messages are sent in real-time to all current participants but are not stored on the server! This means that if you reload the page, you will not see the chat history. This is a security feature to ensure that no sensitive information is stored on the server and to comply with GDPR and other data protection regulations.

There are ways to persist the chat history, but this is not enabled by default. If you want to have a chat history, you need to setup a chat history server. This is a separate service that stores the chat history and can be used to display the chat history in the chat. If you are interested in this feature, please reach out to our sales team.

Next Steps

Learn more about the integrated whiteboard in ODIN Rooms in the Whiteboard Guide.

`}),e.add({id:3560,href:"https://www.4players.io/odin/guides/unreal/android-permissions/",title:"Android Permissions",section:"ODIN Documentation",description:"Learn how to set up Android permissions required for the ODIN plugin in Unreal Engine. Follow this step-by-step guide to configure microphone permissions on Android and Meta Quest VR platforms for seamless voice chat.",content:`

In this guide we’ll show you how to set up Android permissions required to fully use the Odin Plugin in Unreal. These settings will also work for your Meta Quest VR projects.

By David Liebemann at SciCode Studio.

Check and request permissions

We’ll make sure to check our permissions before we actually initialize Odin. The implementation gets called right after BeginPlay in the Custom Event ConnectToRoom that only replicates on the owning client. This ensures that we don’t accidentally request permissions or try to initialize Odin on our server.

Custom event that only replicates on the owning client.

The steps for checking and requesting permissions now are:

We’ll use Get Platform Name to check our current platform - if we’re not on the Android platform, we can instantly go to Init Odin, which contains our logic for joining an Odin room. Otherwise we’ll continue with step 2.

Info

The platform name will also be Android on the Meta Quest.

A call to Check Android Permission with the input android.permission.RECORD_AUDIO will tell us if the user already supplied the microphone permission. If yes, we can jump to Init Odin again, otherwise we’ll need to request the permission.
Before requesting, we’ll need to add a Delay node with an arbitrary duration. This is due to an Unreal issue, that crashes the application if permissions are requested too early. After the delay, we’ll call Request Android Permission with an array that has an android.permission.RECORD_AUDIO entry. The function returns a delegate that allows us to connect to a callback event once the permission was granted or declined.
In the callback, we’ll simply iterate over the result arrays and check for our android.permission.RECORD_AUDIO permission. If the permission was granted successfully, we’ll continue to Init Odin.

The complete blueprint should now look something like this:

Add permissions to manifest

In addition to setting up the request in blueprint, we’ll also need to add the record audio permission in the Android Manifest file. We’ll do this by opening up the project settings, navigating to Android > Advanced APK Packaging and adding the value android.permission.RECORD_AUDIO to the Extra Permissions array.

Android permissions in the project settings.

What’s next?

We’ve shown you the minimal version for checking and requesting microphone permissions for the Android and Meta Quest platform in Unreal.

If a player refuses to give the microphone permission, we currently simply refuse to initialize Odin. In a more sophisticated app we could still allow the player to listen in to the Voice Chat, while not being able to transmit. If the player changes their mind, we could provide a UI element, which reruns the request permissions logic and initializes microphone capturing, if the permission is then granted.

You could take a look at our Sample Project, which includes a minimal multiplayer setup and a detailed demonstration of the Android Permission setup. For an overview of what these samples offer, visit our introduction to the Odin Minimal Samples projects. Ready to dive in? Access the full source code on our GitHub page:

Odin Minimal Samples on Github

For even more information on Unreal with Odin Voice Chat, check out our Discord and take a look at the following guides we’ve prepared for you:

Getting started with ODIN

Follow this guide to learn how to install and setup ODIN in your Unreal Project using Blueprint.

Blueprint Reference

Check out our extensive Blueprint reference to learn more about the nodes our SDK provides and how to connect them into your game.

`}),e.add({id:3561,href:"https://www.4players.io/fleet/manual/configs/",title:"Create Configs",section:"ODIN Fleet Documentation",description:"Learn more about creating and managing server configs in ODIN Fleet.",content:`

A server configuration configures your image. Many Docker images are flexible and can be configured with environment variables, externally mounted configuration files, or both. This guide will show you how to create a server configuration for your game or application.

You can have many configuration, for example for different game modes, maps, or other settings like debug and production.

Basic Configuration

Create Config in ODIN Fleet

In the first have of the editor you’ll find the basic configuration settings:

Name: The name of the configuration. This is used to identify the configuration in the list of configurations.
Image: The Docker image to use for the server. Select the image that will be used to start the server and that you registered before in the Images section. Learn more about images.
Restart Policy: The restart policy for the server. This policy determines what happens when the server stops. You can choose between Never, On Failure, Always. Learn more about restart policies.
Command: Using this setting you can override the default command (CMD) of the image. This is useful if you want to start the server with different parameters or if you want to use a different entry point. More information about command.
Entrypoint: Using this setting you can override the default entrypoint (ENTRYPOINT) of the image. This is useful if you want to start the server with different parameters or if you want to use a different entry point. More information about entrypoint.

Advanced Configuration

This section provides a lot of flexibility to configure your server. You can use environment variables, mount volumes, and configure the network settings.

Port Settings

Create Config in ODIN Fleet

This is a very important setting. Most servers need to expose ports to the outside world so that clients can connect to the server. In this section you can configure the ports that should be exposed by the server.

Click on the Add Port button to add a new port that your server exposes and that should be connected to the hosts network from our backend when the server is started. You can configure the following settings for each port:

Name: The name of the port. This is used to identify the port in the list of ports
Port: This is the port number that the server exposes within the container, i.e. if you run a web server in the container and it listens on port 3000, you would enter 3000 here.
Protocol: The protocol of the port. You can choose between TCP and UDP and both.

Note: It’s important to know is that the port number that you enter here is not necessarily the port number that the server will be accessible from the outside. This is the port number that the server listens on within the container. Our backend finds a free port on the host and maps the container port to the host port. If you need to know the port number that the server is accessible from the outside you can use a Dynamic Environment Variable in the Environment Variables section.

If you are not familiar with ports and the basic concept of exposing ports and dyn, you can learn more about ports here.

Resources

Create Config in ODIN Fleet

In this section you can configure the resources that the server needs to run and can use as a limit. The settings available are subject to your subscription plan. You can configure the following settings:

CPU: The amount of CPU cores that the server at least requires to run and that it can use at most.
Memory: Set the memory reservation and limit for the server. A limit is useful to prevent the server from using too much memory and to prevent the server from being killed by the system.

Environment Variables

Create Config in ODIN Fleet

Environment variables are a powerful way to configure your server. We support three types of environment variables:

Static: These are static environment variables that are always set with the value you set in this configuration
when the server is started. You can use these to set configuration values that are always the same, for example the server’s name, the game mode, or the map.
System: These are environment variables that are set by the system. The actual value is dynamically set by the system when the server is started.
Port: These are environment variables that are set by the system at runtime and contain the actual port number that the server is accessible from the outside.

Static Environment Variables

Click on the Add Variable button to add a new static environment variable. You set the name/key of the variable and the value.

System Environment Variables

Click on the Add Dynamic Variable button to add a new dynamic environment variable. Give it a name/key and select System as the type. Under Value you can select from a list of system environment variables that are available, for example the actual ip address of the host.

Available System Environment Variables:

IP-Address: The actual IP address of the host that the server is running on.
Instance-ID: The index as a number of the instance of the server. This is useful if you run multiple instances of the same server configuration and allows you to differentiate between the instances. I.e. in your Entrypoint script you could adjust the server name based on the instance id.

Port Environment Variables

Click on the Add Dynamic Variable button to add a new dynamic environment variable. Give it a name/key and select Port Mapping as the type. Under Value you can select from a list of ports that are available and that you have configured previously in the Port Settings section.

What happens is that when the server starts our backend iterates over all the ports that you have configured, finds a free port on the host, and maps the container port to the host port. Then this port is set as an environment variable with the name that you have configured here.

Config Files

In this section you can mount configuration files into the server. This is another way to configure your server along with environment variables.

Click on the Add Config File button to add a new configuration file. You can configure the following settings for each configuration file:

Name: The name of the configuration file. This is used to identify the configuration file in the list of configuration files.
Path in Container: The file path and name of the configuration file within the container. This is the path that the server expects the configuration file to be at. For example, if you want to mount a configuration file into the container at /etc/mygame/config.ini you would enter /etc/mygame/config.ini here.
Content: The content of the configuration file. You can enter the content of the configuration file here.

Persistent Folders

Create Config in ODIN Fleet

Files written by the server are lost when the server stops. If you want to persist files between server restarts you can setup folders that will be backed up and restored when the server restarts. Examples for this are databases or log files.

Click on the Add Folder button to add a new folder that should be persisted. You can configure the following settings for each folder:

Path in Container: The path of the folder within the container. This is the path that the server expects the folder to be at. For example, if you want to persist the folder /var/log/mygame you would enter /var/log/mygame here.

Misc Settings

In this section you can configure the following settings:

Notes: You can enter notes for the configuration here. This is useful to document the configuration and to give other users of the configuration an idea of what the configuration is for and how to use it.

Commands

In a Dockerfile, the CMD instruction specifies the default command that should be executed when a container starts. However, you may want to override this default command for various reasons, such as customizing the behavior of the container or specifying different start-up parameters. This can be done using the Command setting.

Using the Command Setting

The Command setting allows you to override the default command (CMD) specified in the Dockerfile when you run the container. This is useful if you need to run a different command or use different arguments than those specified in the Dockerfile.

Example Usage

For example, you may have a Docker image designed to run a web server with a default command of gameserver.exe. However, in some cases, you might want to start the server in a different mode or run a different script altogether. You can specify this alternative command using the Command setting.

Configuring the Command

To set the Command for your server, follow these steps:

Navigate to the Basic Configuration section: In the server configuration editor, locate the Command setting in the Basic Configuration section.
Specify the Desired Command: Enter the command you want to run when the container starts. This command will override the default CMD specified in the Dockerfile.
Save Your Configuration: After specifying the command, ensure you save your configuration to apply the changes.

Example Scenarios

Running in Development Mode: If you need to start your server in development mode, you might override the default command with something like gameserver.exe --debug=false.
Running a Different Script: If you need to run a different script for a specific task, you might specify sh run-server.sh to execute a test script instead of the main application.

Notes

Combination with Entrypoint: If your Dockerfile also specifies an ENTRYPOINT, the command you specify here will be passed as arguments to the ENTRYPOINT command. For example, if the ENTRYPOINT is set to ["gameserver"] and you set the command to --debug=false, the container will execute gameserver.exe --debug=false.
Flexibility: Using the Command setting provides flexibility without the need to modify the Dockerfile, allowing you to adjust the container behavior based on the environment or specific requirements.

By configuring the Command setting appropriately, you can tailor the behavior of your server containers to meet your specific needs and operational requirements.

Entrypoint

In a Dockerfile, you use the ENTRYPOINT instruction to specify the command that should be executed when the container is started. The ENTRYPOINT instruction can be specified with or without an array. If you specify the ENTRYPOINT instruction with an array, the first element of the array is the command and the rest of the elements are the arguments to the command.

With this setting you can override the ENTRYPOINT instruction when you run the container. This allows you to customize the behavior of the container without modifying the Dockerfile depending on the environment.

Example usage

For example, you could have two shell scripts that do upfront work before running the main command. One script could be used for development and the other for production. You can then use the ENTRYPOINT instruction to specify which script to run.

Restart Policy

The Restart Policy option allows you to define the behavior of your server when it stops or crashes. This setting is crucial for maintaining high availability and reliability of your services. You can choose from the following policies:

Never: The server will not restart automatically when it stops or crashes. This policy is useful if you want to manually manage server restarts or if you are performing debugging and need to control when the server restarts.
On Failure: The server will restart only if it exits with a non-zero exit code, which typically indicates an error. This policy is useful for ensuring that your server attempts to recover from unexpected crashes while not continuously restarting if the server is intentionally stopped.
Always: The server will always restart regardless of the exit status. This policy is ideal for production environments where continuous operation is critical, ensuring that your server attempts to restart even after intentional stops or failures.

Configuring Restart Policy

To set the Restart Policy for your server, follow these steps:

Navigate to the Basic Configuration section: In the server configuration editor, locate the Restart Policy setting in the Basic Configuration section.
Select the Desired Policy: Choose between Never, On Failure, or Always based on your needs. Each option will ensure the server behaves according to the selected policy when it stops.
Save Your Configuration: After selecting the appropriate restart policy, ensure you save your configuration to apply the changes.

Example Scenarios

Development Environment: If you are in a development environment and need to control server restarts manually for testing purposes, select the Never policy.
Production Environment: For production servers where uptime is critical, the Always policy ensures your server remains operational by automatically restarting after any stop.
Error Recovery: If your server should only restart after encountering errors and not after a graceful stop, select the On Failure policy.

Understanding and configuring the Restart Policy appropriately can significantly impact the reliability and management of your server fleet. Make sure to choose a policy that aligns with your operational requirements and environment.

`}),e.add({id:3562,href:"https://www.4players.io/odin/guides/unity/event-handling/",title:"Event Handling",section:"ODIN Documentation",description:"Learn how to use ODIN events to customize voice implementation in your games or applications. Dive into the basic application flow, explore event handling, and discover best practices for notification management. Get inspired with example implementations and improve your user experience with ODIN's powerful features.",content:`

Events in ODIN allow you to quickly customize the implementation of voice in your game or application.

Basic application flow

Have a look at this application flow of a very basic lobby application.

1	Join Room	The user navigates to the multiplayer lobby. Here, all players currently playing the game are connected to the same ODIN room so that they can figure out what to play. The application uses JoinRoom function of the OdinHandler instance to join the room. Please note: The server automatically creates the room if it does not exist. There is no need for bookkeeping on your side.
2	RoomJoin	The OnRoomJoin event is triggered. It allows you to handle logic before the user actually joins the room. Please note: All upcoming `PeerJoined` and `MediaAdded` events are for users that were already connected to the room.
3	PeerJoined	For each user connected to the same ODIN room you’ll receive an OnPeerJoined event that allows you to handle logic once a peer joined the room.
4	MediaAdded	For each user connected to the same ODIN room which has a microphone stream enabled (some of them might only be spectators just listening) an OnMediaAdded event is triggered. This event needs to be handled by your application. In this callback, you basically use the AddPlaybackComponent member function of the OdinHandler singleton instance to create a PlaybackComponent that is attached to a GameObject in your scene, depending on your use case. Navigate to the event to learn more and to see some example code.
5	RoomJoined	The OnRoomJoined event is triggered. This event allows you to handle logic after the user joined the room. All `PeerJoined` and `MediaAdded` events that come before `RoomJoined` event are for users that were already connected to the room. Events after `RoomJoined` event indicated changes to the room after the user connected.
6	MediaRemoved	Whenever a user disconnects from the room or closes their microphone stream, an OnMediaRemoved event is triggered. It is your responsibility to clean up the PlaybackComponent components that were created earlier in the MediaAdded callback function.
7	PeerLeft	Whenever a user disconnects from a room, this event is triggered. For example, you can show a push notification that a player has left the room. More info here: OnPeerLeft . Important notice:. Whenever a peer leaves a room, the media gets removed as well. So, aligned with this event, for each media of this peer, a `MediaRemoved` event will be triggered as well.
8	Leave Room	You can use the member function LeaveRoom of the OdinHandler singleton instance to leave a room. Important Notice: Due to the asynchronous nature of leaving a room operation, the current recommendation is to avoid invoking this function within `OnDestroy` if the scene is being unloaded. Scene unloading could occur when transitioning between scenes or shutting down an application. Instead, the best practice is to call the LeaveRoom function and subsequently wait for the OnRoomLeft event to be triggered. Once this event has been triggered, it is then safe to perform further actions, such as calling `LoadScene` or `Application.Quit`.
9	RoomLeave	The event OnRoomLeave is triggered to notify you, that the current user started to leave the room. You can use it to clean up your scene. You can either do that in this event or the next.
10	RoomLeft	The event OnRoomLeft is triggered to notify you, that the current user has left the room. You need to listen to this event to do some cleanup work: You might have some PlaybackComponent components in your scene that you have created earlier. Some (or all of them) are linked to the room that the user just left. Use DestroyPlaybackComponents member function of the OdinHandler singleton instance to remove all PlaybackComponent elements linked to the left room.

Handling Notifications to users

Many applications notify users that other users have left or joined the room. If you show these notifications whenever a PeerJoined event is incoming, you’ll show a notification for every user that is already connected to the user. If you just want to notify users of changes after they have connected the room you have two options:

The property Self of the Room is set in the RoomJoined event. If this property is not null then you can be sure, that the event indicates a change after the user connected
You can set a local Boolean property in your class that is false per default and is set to true in the RoomJoined event. In your PeerJoined event you can check if this property is true or not. Only show notifications if this property is set to true

Example Implementation

We have created a simple showcase demo in Unity. The idea is, that you need to find other players in a foggy environment just by listening to the direction their voice is coming from. We leverage Unitys built-in 3D positional audio by attaching the Voice playback to player game objects so that their voice represents their location in 3D space - they are louder if close, and you might not hear them if they are far away. If they don’t find each other they can use a walkie-talkie like functionality to talk to other players independently of their 3D location.

In the first step, we create this basic walkie-talkie functionality by listening to the following events: OnMediaAdded , OnMediaRemoved and OnRoomLeft .

Walkie-Talkie

This simple example works as follows:

All users are connected to the same ODIN room named “WalkieTalkie1”
We provide an AudioMixerGroup with some audio effects added to the voice of other users, so they sound a bit distorted
In our example, the local player object is controlled by a PlayerController script that has a walkieTalkie member variable that references a walkie-talkie mesh of the player character (see image below).
A singleton GameManager instance handles creation of player objects and manages them. We use this class instance to get hold of our local player object to get a reference to the walkie-talkie game object that we need in the next step.
Whenever another user connects a room, we handle the OnMediaAdded event and attach a PlaybackComponent to this walkie talkie mesh. Therefore, all audio sent by other players voice is coming out of this walkie talkie mesh.

The simplest way to achieve this is by creating a new script in Unity (in this example, we’ll call it OdinPeerManager) and implementing the callback functions within it. After that, you can either create an empty GameObject in your scene and attach the OdinPeerManager component to it, or directly attach the OdinPeerManager to the ODIN Manager prefab that’s already in your scene. Finally, use the inspector of the Odin Manager prefab to link the ODIN SDK events to your custom implementation.

This is the player mesh we used in our ODIN example showcase. It’s Elena from the Unity Asset Store that looks stunning and is very easy to use. Highlighted is the walkie-talkie game object that is used to realistically attach all other players voice to this object. Therefore, other players will hear walkie-talkie sound coming out of this players walkie-talkie as you would in real life.

This is the Elena Soldier Model from the Unity Asset Store that we used in our demo

The final version of our OdinPeerManager implementing what we have defined above looks like this:

OdinPeerManager example

using OdinNative.Odin.Room;
using OdinNative.Unity.Audio;
using UnityEngine;
using UnityEngine.Audio;

public class OdinPeerManager : MonoBehaviour
{
    [ToolTip("Set to an audio mixer for radio effects")]
    public AudioMixerGroup walkieTalkieAudioMixerGroup;

    private void AttachWalkieTalkiePlayback(GameObject gameObject, Room room, ulong peerId, ushort mediaId)
    {
        // Attach the playback component from the other player to our local walkie talkie game object
        PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(gameObject, room.Config.Name, peerId, mediaId);

        // Set the spatialBlend to 1 for full 3D audio. Set it to 0 if you want to have a steady volume independent of 3D position
        playback.PlaybackSource.spatialBlend = 0.5f; // set AudioSource to half 3D
        playback.PlaybackSource.outputAudioMixerGroup = walkieTalkieAudioMixerGroup;
    }

    public void OnRoomLeft(RoomLeftEventArgs eventArgs)
    {
        Debug.Log($"Room {eventArgs.RoomName} left, remove all playback components");

        // Remove all Playback Components linked to this room
        OdinHandler.Instance.DestroyPlaybackComponents(eventArgs.RoomName);
    }

    public void OnMediaRemoved(object sender, MediaRemovedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA REMOVED. Room: {room.Config.Name}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Remove all playback components linked to this media id
        OdinHandler.Instance.DestroyPlaybackComponents(eventArgs.Media.Id);
    }

    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Another player connected the room. Find the local player object and add a PlaybackComponent to it.
        // In multiplayer games, player objects are often not available at runtime. The GameManager instance handles
        // that for us. You need to replace this code with your own
        var localPlayerController = GameManager.Instance.GetLocalPlayerController();
        if (localPlayerController && localPlayerController.walkieTalkie)
        {
            AttachWalkieTalkiePlayback(localPlayerController.walkieTalkie, room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }
}

What’s left is that we need to join the room once the game starts. We do that in our PlayerController script.

Joining a room

public class PlayerController : MonoBehaviour
{    
    // Join the room when the script starts (i.e. the player is instantiated)
    void Start() 
    {
        OdinHandler.Instance.JoinRoom("WalkieTalkie1");
    }
    
    // Leave the room once the player object gets destroyed
    void OnDestroy()
    {
        OdinHandler.Instance.LeaveRoom("WalkieTalkie1");
    }
}

Switching channels

Walkie-talkies allow users to choose a channel so not everyone is talking on the same channel. We can add this functionality with a couple lines of code. The only thing we need to do is to leave the current room representing a channel and to join another room. That’s it.

ODIN rooms are represented by its name. Nothing more. There is no bookkeeping required. Choose a name that makes sense for your application and join that room.

Switching channels

public class PlayerController : MonoBehaviour
{
    // The current walkie-talkie channel
    public int channelId = 1;
    
    // Create a room name of a channel
    string GetOdinRoomNameForChannel(int channel)
    {
        return $"WalkieTalkie{channel}";
    }
    
    // Join the room when the script starts (i.e. the player is instantiated)
    void Start() 
    {
        UpdateOdinChannel(channelId);
    }
    
    // Leave the room once the player object gets destroyed
    void OnDestroy()
    {
        OdinHandler.Instance.LeaveRoom(GetOdinRoomNameForChannel(channelId));
    }
    
    // Leave and join the corresponding channel
    private void UpdateOdinChannel(int newChannel, int oldChannel = 0)
    {
        if (oldChannel != 0)
        {
            OdinHandler.Instance.LeaveRoom(GetOdinRoomNameForChannel(oldChannel));            
        }
        
        OdinHandler.Instance.JoinRoom(GetOdinRoomNameForChannel(newChannel));
    }
    
    // Check for key presses and change the channel
    void Update() 
    {
        if (Input.GetKeyUp(KeyCode.R))
        {
            int newChannel = channelId + 1;
            if (newChannel > 9) newChannel = 1;
            UpdateOdinChannel(newChannel, channelId);
        }
        
        if (Input.GetKeyUp(KeyCode.F))
        {
            int newChannel = channelId - 1;
            if (newChannel < 1) newChannel = 9;
            UpdateOdinChannel(newChannel, channelId);
        }
    }
}

That’s it. You don’t need to change anything in the OdinPeerManager as we already handle everything. If we switch the room, we first leave the current room, which triggers the OnRoomLeft event. As we implemented that event callback we just remove all PlaybackComponent objects linked to this room - i.e. there will be no PlaybackComponent objects anymore linked to our walkie-talkie game object.

Next, we join the other room. For every player that is sending audio in this channel. we’ll receive the OnMediaAdded event which will again create PlaybackComponent objects to our walkie-talkie game object.

3D Positional Audio

As described above, in our example we have two layers of voice: walkie-talkie that we have just implemented and 3D positional audio for each player.

Adding the second layer requires two things:

Joining another room when the game starts. Yes, with ODIN you can join multiple rooms at once and our SDK and servers handle everything automatically for you.
Changing the OnMediaAdded callback to handle 3D rooms differently than Walkie-Talkie rooms.

Joining the world room

All players running around in our scene join the same room, we simply call it “World”. So, we adjust our current Start implementation in PlayerController:

Joining the world room

public class PlayerController : MonoBehaviour
{
    // ...
        
    // Join the room when the script starts (i.e. the player is instantiated)
    void Start() 
    {
        UpdateOdinChannel(channelId);
        
        // Join the world room for positional audio
        OdinHandler.Instance.JoinRoom("World");
    }
    
    // Leave the room once the player object gets destroyed
    void OnDestroy()
    {
        OdinHandler.Instance.LeaveRoom(GetOdinRoomNameForChannel(channelId));
        
        // Leave the world room
        OdinHandler.Instance.LeaveRoom("World");
    }
    
    // ...
}

Adjusting OnMediaAdded

That’s it! We’ve successfully joined the world room. However, at this point, all player voices are being routed to our walkie-talkie, which isn’t what we want. Instead, we want the other players’ walkie-talkies connected to ours, while their “world voice” should be attached to their corresponding avatars in the scene. This way, their voice positions will match their in-game positions, ensuring accurate spatial audio.

Our current implementation on OnMediaAdded looks like this:

Current OnMediaAdded implementation

public class OdinPeerManager : MonoBehaviour
{
    // ...
    
    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Another player connected the room. Find the local player object and add a PlaybackComponent to it.
        // In multiplayer games, player objects are often not available at runtime. The GameManager instance handles
        // that for us. You need to replace this code with your own
        var localPlayerController = GameManager.Instance.GetLocalPlayerController();
        if (localPlayerController && localPlayerController.walkieTalkie)
        {
            AttachWalkieTalkiePlayback(localPlayerController.walkieTalkie, room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }
    
    // ...
}

Depending on the room where the media is added we need to handle things differently. If it’s a walkie-talkie room, we add the PlaybackComponent representing the other players voice to the local players walkie-talkie. This is what we have implemented already. But if it’s the world room, we need to attach the PlaybackComponent to the game object representing the player in the scene.

OdinPeerManager with positional audio

public class OdinPeerManager : MonoBehaviour
{
    // ...
    
    // Create and add a PlaybackComponent to the other player game object
    private void AttachOdinPlaybackToPlayer(PlayerController player, Room room, ulong peerId, ushort mediaId)
    {
        PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(player.gameObject, room.Config.Name, peerId, mediaId);

        // Set the spatialBlend to 1 for full 3D audio. Set it to 0 if you want to have a steady volume independent of 3D position
        playback.PlaybackSource.spatialBlend = 1.0f; // set AudioSource to full 3D
    }
    
    // Our new OnMediaAdded callback handling rooms differently
    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");

        // Check if this is 3D sound or Walkie Talkie
        if (room.Config.Name.StartsWith("WalkieTalkie"))
        {
            // A player connected Walkie Talkie. Attach to the local players Walkie Talkie
            var localPlayerController = GameManager.Instance.GetLocalPlayerController();
            if (localPlayerController && localPlayerController.walkieTalkie)
            {
                AttachWalkieTalkiePlayback(localPlayerController, room, eventArgs.PeerId, eventArgs.Media.Id);
            }
        }
        else if (room.Config.Name == "World")
        {
            // This is 3D sound, find the local player object for this stream and attach the Audio Source to this player
            PlayerUserDataJsonFormat userData = PlayerUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
            PlayerController player = GameManager.Instance.GetPlayerForOdinPeer(userData);
            if (player)
            {
                AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
            }   
        }
    }
    
    // ...
}

If the room where the media was created is a “WalkieTalkie” room, we use the same implementation as before. However, if it’s the world room, we need to find the corresponding player game object in the scene and attach the PlaybackComponent to it. We also set spatialBlend to 1.0 to activate 3D positional audio, meaning Unity will automatically handle the 3D audio processing for us.

Info

This guide covered the basic and essential event handling. We didn’t dive into the specifics of integrating your multiplayer framework with ODIN, as the approach may vary depending on the framework you’re using. We provide a typical solution in our Mirror Networking guide and also have an open-source example available for Photon.

We also demonstrate how to integrate ODIN into an existing multiplayer game in our “ODIN for existing projects” guide.

`}),e.add({id:3563,href:"https://www.4players.io/odin/guides/unreal/device-selection/",title:"Input Device Selection",section:"ODIN Documentation",description:"Discover how to switch microphone input devices in Unreal Engine using the ODIN plugin. This guide walks you through creating an extended audio capture object and implementing a UI for seamless device selection in your game's voice chat.",content:`

Unreal does not provide an easy method to switch input devices (like a microphone) when using the default Audio Capture, even though most players would expect this feature in a game with Voice Chat. Let’s take a look at how we handle this in the ODIN plugin.

By David Liebemann at SciCode Studio.

Creating an Odin Audio Capture

To change input devices, instead of using the default Create Audio Capture method, we’ll use the Create Odin Audio Capture function call. This will create an extended Audio Capture object, that allows us to change the audio capture device using either Blueprints or C++.

Your logic for joining an Odin room should now look something like this:

Please note, that we store a reference to the Odin Audio Capture object as a variable - we’re going to use it in the next sections to display the available devices in the UI.

UI Creation

You’ll probably have to adjust the next steps to fit your UI implementation, but in general it’s easy to adapt the necessary UI elements.

We’ll create a new Blueprint Widget that gets displayed when the player presses \`tab. This Widget should show the available capture devices in a drop-down box and change the active device on selection.

Create a new Widget Blueprint in your project - we’ll call it BPW_SelectInputDevice.
In the widget’s event graph, create a new Custom Event called UpdateAudioCapture with an input parameter of type Odin Audio Capture. We’ll use this event in the next section, so simply leave it unconnected for now.

The Custom Event UpdateAudioCapture in the Widget Blueprint — The Custom Event `UpdateAudioCapture` in the Widget Blueprint

In your player controller’s Begin Play, add a Create Widget call, select the class BP_SelectInputDevice, connect the Self property to the Owning Player input and save the resulting widget object in a variable.

Initializing the device selection widget in the player controller.
The final step in the player controller is to add logic for toggling the “Select Input Device” UI, as shown below. Please note the call to Update Audio Capture when making the UI visible. This will supply the Audio Capture object to the widget blueprint, which we’ll use to request the available capture devices.

Toggle the “Select Input Device” UI based on Input mapping.

Tip

If you can’t create the InputAction ToggleDeviceSelection event, make sure to add an Action in Project Settings > Input > Action Mappings and bind it to a keyboard input - we’re using Tab for testing.

Currently the widget does not contain any visible UI elements, so let’s change this. We’ll add a simple see-through background and a dropdown box, in which we’ll list all available capture devices. Changing the selection in the dropdown box will change the capture device used for Odin. Additionally we’ll preselect the currently active capture device in the dropdown box.

In the widget’s Designer mode, add a Canvas Panel as the root element and a Border and ComboBox (String) as direct children. Set the Border element’s Brush Color to (0,0,0,0.5) to make it darken the gameplay, but still keep it see-through. Additionally, let’s give the ComboBox a meaningful name - e.g. “SelectionDropBox”.

The widget’s hierarchy and display after adding all elements.
Let’s now switch to the Graph mode and start extending our Custom Event UpdateAudioCapture. We’ll store the Odin Audio Capture object as a variable and call Async Get Capture Devices Available. This will return the available capture devices and the current device as outputs in the connected event.

Request the available capture devices.

Warning

The Odin Audio Capture object also contains synchronous function calls to access and change capture device data. During testing we’ve noticed that these synchronous calls can take quite a while to run: more than 100ms on average, in some cases more than a second. This lag is due to Unreal’s internal implementation for changing capture devices. We therefore strongly recommend using the async function calls.

Let’s name the connected event OnReceivedDevices. We’ll store a reference to the available devices, as well as retrieve and store the current device name from the Current Device Info structures.
Because OnReceivedDevices will be called each time we open up the UI, we’ll need to reset the current options by calling Clear Options on the Selection Drop Box.
Now we need to add the available capture device names as options in the dropdown box. We iterate over our Available Devices array, retrieve the Device Name from the device info structures and add that as an option to the Selection Drop Box.
Afterwards we’ll preselect the currently active device by calling Set Selected Option with our Current Option. Your blueprint logic should look something like this:

Filling the dropdown box with available capture device options.
Finally we’ll change the capture device, when the user selects an item from the dropdown box. Add the event On Selection Changed (SelectionDropBox) to your Event Graph. The Selected Item will contain the name of the input device that should become the active capture device. Let’s do a quick check for whether the Selected Item is empty or equal to the currently selected option. If the item passes the checks, we call Async Change Capture Device by Name with the Selected Item as input. The On Change Completed callback will let us know, whether the given device was activated successfully. Your blueprint should look something like this:F

Change the capture device on selection.

Now anytime a user chooses a new option, the Odin Audio Capture object will change the capture device and restart the input stream automatically.

What’s next?

This is a very simple implementation with minimal UI, which you’ll be able to easily adapt to your project’s needs. For more information on Unreal with Odin Voice Chat, check out our Discord and take a look at the following guides we’ve prepared for you:

Getting started with ODIN

Follow this guide to learn how to install and setup ODIN in your Unreal Project using Blueprint.

Blueprint Reference

Check out our extensive Blueprint reference to learn more about the nodes our SDK provides and how to connect them into your game.

`}),e.add({id:3564,href:"https://www.4players.io/odin/guides/unity/unity-mirror/",title:"Multiplayer with Mirror",section:"ODIN Documentation",description:"Learn how to add ODIN voice chat to a simple multiplayer game using Mirror Networking. Follow this step-by-step guide for seamless integration and enhanced in-game communication.",content:`

In this guide we add ODIN to a very simple multiplayer game built with Mirror Networking.

Basic Multiplayer Topology

You might remember this graphic which is provided in the mirror documentation. It’s a good starting point to show how ODIN fits into your multiplayer topology:

This diagram basically outlines the general topology of your multiplayer application.

Clients connect to the server and send input to the server which handles the games state and the objects
Depending on the authority input sent to the server is just controller input (server authority) or a combination of controller input and game object positions and spawn requests (client authority)
The server sends events to the client to keep the clients game state in sync with the master game state on the server

Info

Every client has an exact copy of the scene and its game objects kept on the server. Of course, there is always a slight delay depending on the latency (i.e. connection speed) but overall every client has the exact same state.

Basic Multiplayer Topology with ODIN

Of course, you could build voice into your client server application yourself. Instead of sending packets with controller input or positions, you could also send audio packets. Good luck with that. Audio is extremely hard to get right and there are many different input devices (microphone, headsets, etc). So, it’s easer to just use our technology to add voice communication to your application.

This is the same graphic as above, just with ODIN added to the topology. Let’s dive into it:

Your client/server structure and code is mostly untouched. You can add ODIN without changing anything on your core game
ODIN can also be removed very easily without touching your game logic and topology!
ODIN integration is a pure client side implementation, that is, you don’t need to add anything to the server at all!
Once your player has been connected to the server and the games state is mirrored to the client, ODIN comes into play.
The client joins a room by name and starts sending audio data captured from the input device.
The ODIN server sends events to the client (as your game server does).
Whenever a client is connected to the ODIN server an OnPeerJoined event is sent to the server. An OnMediaAdded event is sent directly after that if the client is sending audio data (someone might be connected to ODIN but without sending any audio - i.e. just a listener)
The client attaches the audio source to the corresponding players game object and removes it once the client disconnects from ODIN
That’s it. The players running around the scene will act as a audio source and it’s up to you how to handle that voice stream in the game

Let’s dive into the actual integration.

Creating a simple multiplayer game

Mirror networking has a very good guide on how to get started. We don’t want to replicate that excellent document here, so head over to Mirror networking and follow the steps. We stopped at Part 11 (as subsequent steps like weapons and switching is not relevant for this guide).

After you have followed the steps, you have created these things:

A new Unity project with a scene that has the NetworkManager script attached to a game object
A player prefab which is a basic capsule with a PlayerScript added and some basic movement.
You can start a Client + Host and run around the scene with WASD on your keyboard and connecting another client will show both clients in the scene

Adding ODIN

In this section, we’ll add ODIN to our simple multiplayer example. Every user connected to the server will join the same ODIN room once connected to the multiplayer server. Each player will act as an AudioSource and will play the voice of the corresponding player in real-time. Audio will use a spatialBlend of 1.0 and as such the 3D position will be taken into account by Unity automatically.

Players voice will come out of the direction they are on screen (or even behind you) and the volume will increase or decrease depending on how close these players are.

Let’s get started!

First, we need to add the Unity ODIN SDK to our project.

Download SDK and install

Follow these steps to install the ODIN SDK into the project. For this guide, we recommend using the Unity Package as it’s the simplest way of installing it.

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Add ODIN Handler Prefab

After installation, you’ll find 4Players ODIN in Packages in your asset browser of Unity. Navigate to Samples/Audio3D and drag & drop the OdinManager 3D Variant prefab into your scene. Click on the prefab and in the inspector you’ll see something like this:

The ODIN Manager Game Object will do the following for you:

Activate the default microphone and capture its input (if “Auto-Start Microphone Listener” is enabled in the Mic-AudioClip Settings section, which is the default setting).
Handles all ODIN events and exposes delegates for these events in the Inspector

Tip

Please check out the ODIN Unity SDK Manual . You’ll find everything you need to know about using ODIN within the Unity editor, including detailed descriptions of all properties for various ODIN components that can be adjusted in the Unity Inspector.

Set Access Token

Now, that we have added ODIN manager to our scene, we need to set an access key. This is an important topic, that we don’t want to dive in deeper right now, but you’ll have to take a minute to understand that later. Check out our guide on this topic here: Understanding Access Keys. As we want to keep things simple, you can generate an access key right from Unity. Click on the Manage Access in the inspector in the Client Settings section in the ODIN Inspector. You’ll see a dialog like this:

You can click on the Generate Access Key to generate an access key for free. This will allow you to connect with up to 25 users. However, there is no support from us.

Mapping ODIN users to players

As you can see in the diagram above it’s important to match ODIN users to the players in the game, so that you can attach the audio output to the correct player. If you are just using “God Voice” mode, i.e. all players have the same volume and direction (like in radio or video conferencing) then this is not required, but it’s recommend.

In Mirror, every networked object has a NetworkIdentity . And every NetworkIdentity has a netId which is an integer value that is unique for every object being part of the network. Every player with a PlayerScript attached to it also has a netId . We just use that netId to match ODIN users with networked player objects.

Every Odin peer has UserData for these use-cases. You can use it to store arbitrary data linked to a user. When the player has been connected to the server, a local instance of the player is created and the OnStartLocalPlayer function is called.

With ODIN integrated, the PlayerScript.OnStartLocalPlayer function looks like this:

OnStartLocalPlayer implementation

public override void OnStartLocalPlayer()
{
    sceneScript.playerScript = this;
    
    Camera.main.transform.SetParent(transform);
    Camera.main.transform.localPosition = new Vector3(0, 0, 0);
    Camera.main.transform.localRotation = Quaternion.identity;
    
    floatingInfo.transform.localPosition = new Vector3(0, -0.3f, 0.6f);
    floatingInfo.transform.localScale = new Vector3(0.1f, 0.1f, 0.1f);

    string name = "Player" + Random.Range(100, 999);
    Color color = new Color(Random.Range(0f, 1f), Random.Range(0f, 1f), Random.Range(0f, 1f));
    
    // Generate a JSON User Data object with the players netId and name in the network
    CustomUserDataJsonFormat userData = new CustomUserDataJsonFormat(name, "online");
    userData.seed = netId.ToString();
    
    // Join ODIN Room ShooterSample and send user data
    OdinHandler.Instance.JoinRoom("ShooterSample", userData.ToUserData());
    
    // Send users data to the server
    CmdSetupPlayer(name, color, netId.ToString());
}

As you can see, we generate a simple UserData JSON object with name and seed. seed is an “external” identifier that can be used to link the games identifiers to ODIN.

Tip

Please note: UserData in ODIN is just a byte array and can be used for anything. It can be updated with the UpdateUserData method provided in the Room class of the ODIN SDK. You can use the class CustomUserDataJsonFormat which provides a standard interface that is also used in our Web SDK (so both can work seamlessly together). CustomUserDataJsonFormat serialized its data to a JSON (ToUserData and FromUserData ) representation.

Once that is done, we join the ODIN room ShooterSample. We have also extended the CmdSetupPlayer function and added another parameter to send the users netId to the server and to keep it in sync with the other clients:

Adding sync var for odin seed

[SyncVar(hook = nameof(OnNameChanged))]
public string playerName;

[SyncVar(hook = nameof(OnColorChanged))]
public Color playerColor = Color.white;

// The new SyncVar to store the users netId as an ODIN seed
[SyncVar]
public string odinSeed;

This is the new version of CmdSetupPlayer after integrating ODIN:

Updating CmdSetupPlayer

[Command]
public void CmdSetupPlayer(string _name, Color _col, string netId)
{
    // player info sent to server, then server updates sync vars which handles it on all clients
    playerName = _name;
    playerColor = _col;
    odinSeed = netId;
    sceneScript.statusText = $"{playerName} joined.";
}

That’s it. Now every user will expose their ODIN identifier to the network and will also send that identifier to ODIN. Of course, many other things can be used as the identifier, being it the user id from authentication or a random id.

Understanding ODIN rooms

ODIN follows a couple of very simple rules:

All users connected to the same room can hear everyone else (except when they are muted)
A room is created once the first users is connected and is deleted once the last user disconnects from it
One user can join multiple rooms simultaneously

So, it’s up to us to decide how we leverage that. You can have one large room for all players or you can have a room for each team. And you can also have multiple rooms at the same time. Think about a game like CounterStrike. There could be three rooms:

In one room, every player is connected and this room uses positional 3D audio
One room for Terrorists (i.e. all players in the Terrorist Team are connected via virtual radio) which uses layered audio
One room for Counter Terrorists (i.e. all players in the CT Team are connected via virtual radio) which uses layered audio

In this scenario players can talk to everyone else crystal clear as they would in real life via radio or phone. But players would also expose their voice inside the game at their 3D position. So, if you talk to others, an opponent which is close to you can listen to what you are talking about. This exposes your position and it also gives opponent a chance to learn about your strategy.

In our example, we’ll stick to one room using 3D audio. Every AudioSource in Unity has a property called spatialBlend . Here is an excerpt of the Unity documentation:

Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.

What we do with ODIN is attach a special ODIN-powered AudioSource to the player object (head) and set spatialBlend to 1.0 to enable full 3D audio. If you want to use “God voice” mode, i.e., no 3D positioning, you would set that value to 0.0. That’s it! With ODIN, this is all you need to do to achieve either standard, equal volume radio-type voice or 3D positional audio.

Attach ODIN voice to player objects

Let’s recap what we have now:

We have a simple multiplayer “game” that allows multiple players to connect and run around the scene
Every player connects to the ShooterSample room in ODIN and exposes a unique ID (in this case the NetworkIdentity.netId) to the network and ODIN

Once connected to ODIN, the ODIN server will send events whenever something of interest happens. Right after connecting, ODIN will send a couple of OnPeerJoined and OnMediaAdded events to inform about all players already in that room.

You can hook up those events via code or by linking them in the inspector in Unity. In this example, we do it via Inspector.

So, we create a new Game Object in the scene called Odin Peer Manager and create a new script OdinPeerManager which is linked to the Odin Peer Manager game object. This is the complete OdinPeerManager script:

OdinPeerManager example

using System.Collections;
using System.Collections.Generic;
using Mirror.Examples.Chat;
using OdinNative.Odin;
using OdinNative.Odin.Room;
using OdinNative.Unity;
using OdinNative.Unity.Audio;
using QuickStart;
using UnityEngine;

public class OdinPeerManager : MonoBehaviour
{
    private bool muted = false;

    private void AttachOdinPlaybackToPlayer(PlayerScript player, Room room, ulong peerId, int mediaId)
    {
        PlaybackComponent playback = OdinHandler.Instance.AddPlaybackComponent(player.gameObject, room.Config.Name, peerId, mediaId);

        // Set the spatialBlend to 1 for full 3D audio. Set it to 0 if you want to have a steady volume independent of 3D position
        playback.PlaybackSource.spatialBlend = 1.0f; // set AudioSource to full 3D
    }

    public PlayerScript GetPlayerForOdinPeer(CustomUserDataJsonFormat userData)
    {
        if (userData.seed != null)
        {
            Debug.Log("Player has network Id: " + userData.seed);
            PlayerScript[] players = FindObjectsOfType<PlayerScript>();
            foreach (var player in players)
            {
                if (player.odinSeed == userData.seed)
                {
                    Debug.Log("Found PlayerScript with seed " + userData.seed);
                    if (player.isLocalPlayer)
                    {
                        Debug.Log("Is local player, no need to do anything");   
                    }
                    else
                    {
                        // We have matched the OdinPeer with our local player instance
                        return player;
                    }
                }   
            }
        }

        return null;
    }

    public void RemoveOdinPlaybackFromPlayer(PlayerScript player)
    {
        PlaybackComponent playback = player.GetComponent<PlaybackComponent>();
        Destroy(playback);

        AudioSource audioSource = player.GetComponent<AudioSource>();
        Destroy(audioSource);
    }

    public void OnMediaRemoved(object sender, MediaRemovedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA REMOVED. Room: {room.Config.Name}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");
        
        CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
        PlayerScript player = GetPlayerForOdinPeer(userData);
        if (player)
        {
            RemoveOdinPlaybackFromPlayer(player);
        }
    }

    public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
    {
        Room room = sender as Room;
        Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");
        
        CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
        PlayerScript player = GetPlayerForOdinPeer(userData);
        if (player)
        {
            AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }

    public void ToggleMute()
    {
        muted = !muted;
        
        foreach (var room in OdinHandler.Instance.Rooms)
        {
            OdinHandler.Instance.Microphone.MuteRoomMicrophone(room, muted);
        }
    }
}

We are only interested in the OnMediaAdded and MediaRemoved events. Those events are sent whenever a user has joined a room and started to send audio. Or if that player stopped sending audio.

So, we created two functions OnMediaAdded and OnMediaRemoved and linked those two events in the Odin Manager:

ODIN events linked to our new OdinPeerManager object

Warning

Please make sure that the events OnMediaAdded and OnMediaRemoved are activated in the Event Listeners section.

Let’s dive into that a bit. OnMediaAdded is triggered for each player connected to ODIN when the current player connects, and it will also be triggered if another player joins later.

OnMediaAdded example code

public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
{
    Room room = sender as Room;
    Debug.Log($"ODIN MEDIA ADDED. Room: {room.Config.Name}, PeerId: {eventArgs.PeerId}, MediaId: {eventArgs.Media.Id}, UserData: {eventArgs.Peer.UserData.ToString()}");
    
    CustomUserDataJsonFormat userData = CustomUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
    PlayerScript player = GetPlayerForOdinPeer(userData);
    if (player)
    {
        AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
    }
}

The sender is of type Room, which lets us cast it to a Room object. The MediaAddedEventArgs object contains information that is sent from the server to the client. We are mostly interested in the UserData object. We can convert the generic object using the CustomUserDataJsonFormat.FromUserData method to a CustomUserDataJsonFormat object that has this structure :

CustomUserDataJsonFormat Properties

public class CustomUserDataJsonFormat
{
    public string name;
    public string seed;
    public string status;
    public int muted;
    public string user;
    public string renderer;
    public string platform;
    public string revision;
    public string version;
    public string buildno;        
    
    ...
}

Perhaps you remember that when connecting to the ODIN room (see above) we created a UserData object in OnStartLocalPlayer:

Mapping ODIN peers to users

  // Generate a JSON User Data object with the players netId and name in the network
  CustomUserDataJsonFormat userData = new CustomUserDataJsonFormat(name, "online");
  userData.seed = netId.ToString();
  
  // Join ODIN Room ShooterSample and send user data
  OdinHandler.Instance.JoinRoom("ShooterSample", userData.ToUserData());

As you can see, we used the seed property to set a unique ID within the ODIN ecosystem (which is the netId).

The seed in this CustomUserDataJsonFormat is a network identifier that should be available within the current scene. Our task is to find all PlayerScript objects in the scene and locate the one with the corresponding netId — this will match the player to the ODIN user. This is handled in the GetPlayerForOdinPeer function.

Tip

Please note: The OnMediaAdded event is sent for all players in the room, including the local player. We don’t want to attach the AudioSource to the local player, as we would then have an echo. So we check out if the found player is the local player with isLocalPlayer and if that’s the case, we just return null.

Now that we matched the player to the ODIN peer, we just need to attach the special ODIN powered AudioSource which will basically just output the users microphone input to the corresponding player object. We do that in the AttachOdinPlaybackToPlayer function which in turn uses the AddPlaybackComponent function of the ODIN SDK.

We get back a PlaybackComponent that we can use to adjust the spatialBlend . In this case, we set it to 1.0 to enable full 3D audio. You can also change that to 0.0 to have radio like voice communication.

That’s it!

Congratulations! You have successfully integrated ODIN into a multiplayer game with 3D spatial audio. Multiple players can now connect to the server, and their voices will be played from their avatar’s position, with the volume adjusting based on distance.

`}),e.add({id:3565,href:"https://www.4players.io/odin/guides/unity/pun-sample/",title:"Multiplayer with Photon",section:"ODIN Documentation",description:"Explore David Liebemann's open-source Unity & Photon PUN 2 sample game showcasing ODIN's features, including 3D positional voice chat. Download and learn how to integrate ODIN into your game.",content:`

David Liebemann at SciCode Studio created a sample game with Unity and Photon PUN 2 that showcases all features of ODIN in a simple example.

It’s open source and available in our Github repository. You can download the binaries to test it here:

Download Sample now

In this guide we’ll walk you through the basic concepts of integrating ODIN into a multiplayer game. This demo will use the Photon PUN 2 multiplayer framework, but ODIN can be integrated into your game using any multiplayer solution or even without multiplayer. The ODIN-Demo itself also allows us to easily switch out Photon for another framework.

If you are unsure why you should use ODIN for that, learn more about our features and what makes us special in our introduction.

How does it work?

The basic network topology looks like this:

graph LR
  subgraph ODIN Server
    OR[Odin Room]    
  end
  subgraph Photon Cloud
    GS[Gameserver]
  end
  subgraph Game
    GS[Game Server] --> ClientA[Player A] --> OR[ODIN Room]
    GS[Game Server] --> ClientB[Player B] --> OR[ODIN Room]     
    GS[Game Server] --> ClientC[Player C] --> OR[ODIN Room]     
  end

Players connect to the Photon PUN 2 cloud and use that to sync the players position, name and colors. Every player is also connected to the same ODIN room - therefore all players that see each other also hear each other - of course only if they are close enough to each other and there is no wall between them.

In other voice SDKs you would need to transfer a lot of information to the voice cloud or you would need to process the game world to set the volume and balance of players. We can improve a lot on this process.

In ODIN, nothing like that is required. There is one place where all information comes together: Within the player’s Unity game client. Therefore, ODIN just uses the game engines audio features. You only need to map the corresponding player media stream coming from the ODIN server to the correct GameObject representing the player and use AddPlaybackComponent to attach it. That’s it.

The sample comes with the AOdinMultiplayerAdapter class - it’s an abstract base class that you can use to implement a mapping solution for any multiplayer framework. If you are using Photon PUN2, you can just use our implementation for that adapter for PUN 2: PhotonToOdinAdapter .

Cloning the repository

Please note: The repository uses LFS. You need to clone this repo with LFS enabled. Downloading the ZIP file via Githubs Download ZIP functionality does not work!

To enable git lfs, enter git lfs install in your git bash in your local repository.

Project Structure

The ODIN-Demo project’s scripts are split up into the categories:

Audio: Scripts in here handle the custom Audio System behaviour like directional audio and occlusion effects.
ODIN: Handles anything related to core ODIN-features, without external dependencies. If you’d like to use a multiplayer framework other than Photon, you can safely reuse the files contained in this assembly.
Photon: Anything Photon specific is contained in here, like joining Photon Rooms or synchronizing Player Position.
GameLogic: Anything else required for the demo, like the player’s movement or view state (1st-person or 3rd-person).

You can find demo settings in the Assets > ODIN-Demo > Settings directory, e.g. settings for the occlusion effects, ODIN room names, Push-To-Talk settings and Input definitions. Any prefabs used in the demo can be found in the Assets > ODIN-Demo > Prefabs directory, with the player prefab being located in the Resources.

The demo scene’s hierarchy contains three root game objects used for categorizing behaviours:

Environment: Contains all visible objects or lights that contain the scene’s visuals.
Gamelogic: Behaviours like the PhotonPlayerSpawner or the ODIN room join logic are placed here.
UI: The root object for in-game UI, like the settings menu or the radio room’s active user display.

ODIN terms and behaviours

This is a short introduction into the most important ODIN terms - for more in-depth information please take a look at the ODIN documentation.

Rooms, Peers and Media

Every client connects to an ODIN server, authenticates with an access token and joins a room. Once the client has joined a room, they are a peer inside the ODIN room. Every peer can add media to that room, linked to a physical device like a microphone. Clients can join multiple rooms at the same time and can add multiple media streams at the same time.

To find more information on the basic ODIN topology, please take a look at the Basic Concepts documentation.

OdinHandler

The OdinHandler script is a singleton behaviour, wrapping the functionality of the native ODIN SDK for use in Unity. You can access the script via OdinHandler.Instance.

The most important use-cases are the OdinHandler.Instance.JoinRoom method for joining ODIN rooms and the events for listening for ODIN events, like OnRoomJoin, OnPeerJoined and OnMediaAdded. To use the OdinHandler, make sure to add a variant of the OdinManager prefab into your project. The prefab also contains the OdinEditorConfig script, which allows us to set the Access Key and Room Audio Processing settings in the inspector.

If you don’t yet have an ODIN subscription and just want to test out ODIN’s functionality, you can use a generated key by pressing the Manage Access Button and then selecting Generate Access Key. The resulting access keys can be used to access the ODIN network with up to 25 concurrently connected users free of charge.

The OdinManager prefab in the inspector view.

PlaybackComponent

The ODIN SDK provides the PlaybackComponent script to easily play back audio data received from the ODIN server. Each PlaybackComponent represents one media stream and is identified by a media id, a peer id and a room name.

User Data

Every peer in Unity can store arbitrary information as user data. When local user data is updated, the server updates user data on all clients. Read more about user data in the guide: Understanding User Data.

Multiplayer

Lobby

Because ODIN works framework independent, we won’t go too much into detail on how to set up Photon - for an in-depth explanation, please take a look at Photon’s starter guide.

Note: When first entering the Unity project, Photon will require you to add an App Id - simply follow the instructions to add or create your own App Id.

We wait for a connection to the photon network, before allowing users to join a Photon room. In the demo we’ll simply add all players to the same room. We also use the PhotonNetwork.AutomaticallySyncScene = true option to automatically load the correct scene for each player joining.

After pressing the Join Button, the player will either connect to an existing Photon room or create a new Photon room as a Master Client. As a master client, we’ll use the call:

    PhotonNetwork.LoadLevel(sceneToLoad);

Otherwise Photon will automatically load the correct scene.

Demo Level

When entering the Demo Level scene, two things happen:

We instantiate the player over the Photon network using PhotonNetwork.Instantiate and the ODINPlayer prefab. This is kicked off by the PhotonPlayerSpawner script on Start. Note: The player prefab needs to be located in a Resources subdirectory, in order for Photon to be able to instantiate the player correctly.
We automatically connect to two ODIN rooms (Voice and Radio) with

OdinSampleUserData userData = new OdinSampleUserData(refPlayerName.Value);
OdinHandler.Instance.JoinRoom(refRoomName.Value, userData);

We don’t have to send user data when joining an ODIN room, but in this case we already have access to the player name from the value entered in the Lobby scene, so it makes sense to supply it while joining.

OdinSampleUserData is a serializable C# class which implements the IUserData interface. This is a requirement for any userdata transmitted using ODIN. The interface member function ToBytes() simply provides an UTF8 encoding of a JSON representation of the class. The class contains app specific properties like the player’s name, his capsule color and a unique user id. The unique user id is used to connect an ODIN media stream to a Photon View - specifically the unique user id is equal to the photon view id - and therefore required for the proximity chat.

ODIN

Global Voice Chat - Radio transmissions

In the demo project, users automatically join the ODIN room named Radio, in which players can communicate as if using radio transmitters - when pressing down the V key, the microphone input can be heard by all players in the room independent of their position.

For this scenario, the demo project provides the OdinDefaultUser script, which uses the OdinHandler.Instance.OnMediaAdded Event to spawn an instance of a prefab with a PlaybackComponent for each media stream in the ODIN room. The event provides the room name, peer id and media id required for the PlaybackComponent to work.

We added the OdinDefaultUser script as a local-player-only behaviour - so it will only spawn Playbacks as children of the Player. This doesn’t matter for our radio transmissions, because they can be heard globally and shouldn’t react to the distance between the local Player and remote Players. It also ensures, that each radio stream will only be spawned once for the player. But it also entails that the OdinDefaultUser script should only be used for ODIN rooms which do not make use of proximity voice chat.

In the next paragraph we’ll take a look at how the Tech Demo implements a Proximity Chat which reacts to the distance between local Player and remote Players. We’ll also take a look at how to create the “Radio Crackling” Effect in paragraph Playback Settings.

Proximity Chat - connecting ODIN to the multiplayer framework

In a multiplayer scenario, we encounter the issue of connecting a user’s ODIN media stream to the user’s avatar in the game, e.g. in our demo project we’d want a player’s voice in the proximity chat to come from the player’s capsule. But because ODIN and the multiplayer framework don’t know of each other’s existence, we first have to logically connect the two concepts.

The abstract AOdinMultiplayerAdapter script gives access to the methods string GetUniqueUserId() and bool IsLocalUser(). This adapter is used to connect the player’s representation in the multiplayer framework (using the framework’s equivalent of an unique user id) to an ODIN peer. On ODIN’s side we use custom user data to keep track of that id. When joining an ODIN room, the AOdinMultiplayerAdapter automatically sets the uniqueUserId of our custom ODIN user data for the current peer and sends an update to the other peers in the room. On receiving the update, those clients then use a reference to AOdinMultiplayerAdapter to compare the remote peer’s uniqueUserId to the id supplied by the remote adapter’s GetUniqueUserId(). If both ids are equal,we know that an ODIN peer is represented by the referenced AOdinMultiplayerAdapter.

Diagram showcasing the adapter pattern for connecting ODIN to a multiplayer framework.

In the demo project we use this information to correctly play black the proximity chat audio at a player’s location - specifically using the Odin3dAudioVoiceUser, which automatically creates a PlaybackComponent for each remote user.

The demo project utilizes Photon as a multiplayer framework, so we add the PhotonToOdinAdapter to our player. The adapter uses PhotonView.ViewID as a unique user id and PhotonView.IsMine to determine whether the adapter represents a local or a remote player. To switch out Photon for another multiplayer framework, simply provide your own class extending AOdinMultiplayerAdapter.

Playback Settings - Distance and Radio Effects

ODIN relies on Unity’s AudioSource Components to play Media Streams. We can therefore just use the built in functionality of Audio Sources to adjust the distance at which players can hear each other. For any AOdinUser implementation (i.e. OdinDefaultUser for Radio transmissions and Odin3dAudioVoiceUser for Proximity Voice Chat) we can reference a prefab that will be spawned for each Media Stream. These Prefabs not only have a PlaybackComponent on them, but also contain an AudioSource. So, to change the Playback Behaviour of Media Streams in-game, we have to change the AudioSource Settings on the prefab. The Tech Demo uses the prefabs OdinRadioAudioSource and OdinVoiceAudioSource in the ODIN-Sample > Prefabs folder.

The OdinRadioAudioSource prefab simply has a full 2D Spatial Blend setting and the Bypass Reverb Zone enabled. The latter lets us avoid Unity’s Reverb Zones, e.g. Echo effects in large rooms. The most interesting setting can be found in the Output option - here we reference an Audio Mixer Group Controller. The Radio Group Controller defines the list of effects that the incoming Radio room Media Streams go through, before being output to the User. The combination of these effects creates the Radio’s crackling effect, giving Players a more immersive experience.

The Radio Mixer Settings for creating the crackling effect.

The OdinVoiceAudioSource prefab on the other hand has a full 3D Spatial Blend setting and does not bypass reverb zones - we want this AudioSource to simulate a human voice in the real world, which is naturally affected by the environment. The prefab uses the 3D Sound Settings of the AudioSource component to further specify this effect - the Min Distance value defines the distance at which the voice will be heared at full volume and the Max Distance defines the distance at which we won’t hear the voice anymore. Additionally we can see the Volume Rolloff set to Logarithmic Rolloff - this best approximates a real world setting. If required, the rolloff can easily be customized by choosing a linear or custom setting.

The AudioSource component’s 3D sound settings.

These three options majorly define the fading behaviour of a player’s voice in the distance - at least when there aren’t any objects between the audio source and listener. Occlusion effects are not part of Unity’s Audio System, but we’ve included our own, custom solution for this in the Tech Demo, which is explained in-depth in the Audio Occlusion paragraph.

Proximity Chat - Room Optimization

Another feature of ODIN is, that the ODIN servers can automatically stop the transmission of Media Streams based on the spatial distance between the local player and other players in the ODIN room. This allows us to optimize the bandwidth required for each player, avoiding unnecessary downstreams for voice transmissions that can’t be heard by the player due to distance anyway! Of course, we only want to use this for proximity-based ODIN rooms, not for global rooms like the Radio Chat.

To enable this feature, we use the methods

room.SetPositionScale(scale);

and

room.UpdatePosition(position.x, position.y);

As ODIN is not aware of the scale your game is operating at, it initially uses a Unit Circle as the cutoff radius. If we use the previously mentioned Max Distance to calculate scale as

float scale = 1.0f / MaxVoiceDistance;

we can automatically disable streams that wouldn’t be transmitted by the Audio Source due to distance anyway.

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.

Warning

Invoking room.UpdatePosition too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling room.UpdatePosition to a maximum of 10 times per second. This equates to one update every 100 milliseconds. We recommend using a Unity Coroutine to update the position in Odin rooms.

For ODIN to be able to use the distance values for optimization, we have to transmit player positions at regular intervals. The function room.UpdatePosition lets us define the client’s current position in the room. If we define the correct room scale, we can simply use the player’s transform.position x and z values.

Note: For now, we can only transmit 2D positions with this method. But as most games have a wide horizon and aren’t scaled vertically, this is not a real drawback.

In the Tech Demo, the OdinPositionUpdate component regularly updates the player’s position. Using entries to the Room Settings array on the OdinPositionUpdateSettings scriptable object, we can define the activation status and the cutoff radius for each ODIN room individually.

The ODIN room optimization and position update settings.

Push-To-Talk

Push-To-Talk is handled by the OdinPushToTalk script using settings defined in a OdinPushToTalkSettings scriptable object. If the push-to-talk button for a specific room is pressed, the script will access the user’s mediastream and set a user’s mute status using targetRoom.MicrophoneMedia.SetMute().

The OdinPushToTalkSettings scriptable object allows rooms to be either be voice-activated or require a button press to talk - if you’d like to make this available as a user-setting, you can use the OdinPushToTalkSettingsController, which automatically sets the room’s activation method based on a Unity Toggle. Take a look at the Tech Demo’s Settings prefab (found in ODIN-Sample > Prefabs > UI) for more information.

Audio Filter Settings

The ODIN SDK provides quite a few Room Audio Processing settings, like Voice Activity Detection, Echo Cancellation, Noise Suppression levels and more. If you’re content with using the same settings for all users, you can simply adjust the values on the OdinManager prefab (as shown here).

The Tech Demo has a sample implementation on how to allow users to adjust these settings in the game. The Settings prefab (found in ODIN-Sample > Prefabs > UI) uses Unity’s Toggle, Slider and Dropdown UI components to adjust the Audio Settings. The OdinAudioFilterSetingsController script contains entries that map the UI component’s input to ODIN’s filter values and even stores the changes to file. For a fast integration into your game, you can use the Tech Demo implementation and adjust the UI graphics to your liking.

The UI for adjusting the Audio Filter Settings.

Choosing an Input Device

The previously mentioned Settings prefab also allows players to choose their input device. The options that are available are based on Unity’s Microphone.devices ouput and displayed in the dropdown component. Updating the input device used by ODIN is then as simple as calling

MicrophoneReader microphoneReader = OdinHandler.Instance.Microphone;
microphoneReader.StopListen();
microphoneReader.CustomInputDevice = true;
microphoneReader.InputDevice = selectedDevice;
microphoneReader.StartListen();

where the selectedDevice is one of the string options listed in the Microphone.devices array. The Tech Demo uses the implementation in the OdinMicrophoneController script, which also handles saving and loading the users selection in previous game sessions.

Audio

To better showcase the capabilities of ODIN in apps and games, we’ve implemented some audio features that are often used in games, but not included in Unity’s Audio System: Audio Occlusion and Directional Audio. Because we want to keep things simple and performant, we’re going to approximate those effects, using Unity’s AudioLowPassFilter component and by adjusting the volume of individual audio sources.

Audio Occlusion

Audio Occlusion should occur when an object is placed between the audio listener (our player) and audio sources in the scene - e.g. hearing the muffled sounds of an enemy approaching from behind a wall. Unity does not have any kind of built-in audio occlusion, so we need to implement our own system. The OcclusionAudioListener script contains most of the occlusion logic and is placed, together with the AudioListener script, on our local player object. The OcclusionAudioListener registers objects with colliders, that enter the detection range and have at least one AudioSource script attached in the transform hierarchy. By default the detection range is set to 100 meters - Audio Sources that are farther away than that are usually not loud enough to be affected meaningfully by our occlusion system. We then apply the occlusion effects to each of the registered Audio Sources in every frame.

Our occlusion effects have the parameters Volume, Cutoff Frequency and Lowpass Resonance Q:

Volume: Multiplier for the audio source’s volume.
Cutoff Frequency: Removes all frequencies above this value from the output of the Audio Source. This value is probably the most important for our occlusion effect, as is makes the audio sound muffled. The cutoff frequency can range from 0 to 22.000 Hz.
Lowpass Resonance Q: This value determines how much the filter dampens self-resonance. This basically means, the higher the value, the better sound is transmitted through the material the filter is representing. E.g. for imitating an iron door, the Lowpass Resonance Q value should be higher than for imitating a wooden door.

The occlusion effect is based on the thickness of objects between our AudioListener and the AudioSource. For each audio source we check for colliders placed between the listener and the source using raycasts and determine the thickness of the collider. This thickness value is then used to look up the final effect values from an AudioEffectDefinition ScriptableObject. For each of the three parameters Volume, Cutoff Frequency and Lowpass Resonance Q the ScriptableObject contains a curve, which maps from the collider’s thickness on the x-Axis to the parameter value on the y-Axis.

The image below shows an Audio Effect Definition Scriptable Object for the Concrete material. When selecting the Cutoff Frequency Curve, Unity’s Curve Editor window shows up to allow finetuning the settings. The x-axis displays the thickness of an occluding object in meters. The curve then maps to the cutoff frequency displayed on the y-axis.

The Audio Effect Definition Scriptable Object.

The AudioEffectDefinition is retrieved using one of two options:

By placing an AudioObstacle script on the collider’s gameobject. This can be used to customize a collider’s occlusion effect and give it a certain material’s damping behaviour. The demo uses the AudioObstacle to define the occlusion effect of a brick wall, a wooden door, a glass pane or even a 100% soundproof barrier.
By falling back to the default AudioEffectDefinition - this option is used, if no AudioObstacle is attached to the collider.

You can create your own AudioEffectDefinition by using the Create > Odin-Sample > AudioEffectDefinition menu in your project hierarchy.

Directional Audio

Unity’s built in audio system allows us to hear differences between sounds coming from left or right, but not whether the object is in front or behind us. The DirectionalAudioListener script will take care of this using basically the same effects as the audio occlusion system.

Similar to the OcclusionAudioListener, we apply an effect to each Audio Source in the detection range - but instead of using the thickness of objects between source and listener, we interpolate the effect based on the angle between the listener’s forward vector and a vector pointing from the listener to the audio source.

Note: The implementation currently won’t let us differentiate between sound coming from above or below. To implement this behaviour, please take a look at the implementation of Head Related Transfer Functions (HRTF).

Environmental Effects

The Tech Demo Level contains a few rooms, that highlight the Audio Occlusion effect for different materials. Additionally, we’ve used Unity’s AudioReverbZone components to add environmental effects to these rooms, to further increase the players immersion. Unity provides a few presets which simulate different environments - e.g. the Demo Level’s “Brick Room” uses the Stone Corridor preset - but also allows to be set to a custom arrangement. The effect will start to be heared at MaxDistance and is at full force inside of the MinDistance radius.

While the Voice transmissions are affected by the reverb zones, the Radio transmissions are not, due to the Bypass Reverb Zone setting on the Playback Prefab - as described here.

The Brick Room with the highlighted Audio Reverb Zone.

Game Logic

Player Name and Color Synchronization

The OdinNameDisplay and OdinSyncedColor scripts use the ODIN’s custom User Data to synchronize the player’s name and avatar color. With OdinHandler.Instance.OnPeerUserDataChanged.AddListener() we listen to any changes on a remote peers User Data - if the peer’s UniqueUserId equals the Multiplayer Adapter’s GetUniqueUserId(), we read the name and display it above the peer’s avatar using a world-space canvas and display the color on the avatar’s mesh.

Mobile Controls

Because ODIN works on mobile platforms, we’ve added mobile controls to the Tech Demo. The implementation is based on Unity’s new Input System and allows players to move, rotate, use Push-To-Talk and switch from 3rd to 1st-person view with On-Screen controls. Take a look at the UI > MobileControlsCanvas in the DemoLevel scene’s hierarchy for implementation details. The mobile controls can be simulated in Editor by selecting the Enable in Editor option on the ActivateIfMobile script.

Toggling the in-game radio objects

The ToggleRadioBehaviour script implements the basic behaviour for turning the in-game radio sources on and off - if an avatar enters the detection radio, the controlling player will be able to toggle the radio status with a button press. The status then gets synchronized with the PhotonRadioSynchronization behaviour, which listens to the toggle’s onRadioToggled UnityEvent.

If you’d like to implement another multiplayer framework, simply replace the PhotonRadioSynchronization with your own synchronization behaviour.

Switching Player Views

Users can switch from 3rd-person to 1st-person view on button press - this is implemented in the ToggleViews script by toggling game objects found in the ODINPlayer > LocalPlayerBehaviours > ControllerState hierarchy of the ODINPlayer prefab. The FirstPersonBehavior object contains the camera and behaviours for 1st-person controls, the ThirdPersonBehavior contains everything for 3rd-person controls.

`}),e.add({id:3566,href:"https://www.4players.io/odin/guides/unity/existing-projects/",title:"ODIN for existing projects",section:"ODIN Documentation",description:"Learn how to integrate ODIN proximity voice chat into your Unity multiplayer game using the open-source Tanknarok Photon Fusion project. Enhance your gaming experience with voice chat, even after release!",content:`

David Liebemann at SciCode Studio added ODIN to an existing multiplayer game - the Photon Fusion Tanknarok sample - to showcase the steps you need to take to integrate ODIN’s proximity voice chat to your own multiplayer application. Using these tips you can easily add voice chat to your game even after release!

The Unity project is open source and available as a Github repository. You can download the binaries to test it here:

Download Sample now

Integrating ODIN into an existing multiplayer project

In this guide we’ll show you how to integrate ODIN into an existing multiplayer project. We’ll use the Photon Fusion Tanknarok project as a base multiplayer project without any Voice Chat. In just a few steps you’ll learn how to take your project to the next level by integrating ODIN and adding proximity voice chat.

Photon Fusion is a multiplayer framework used in many Unity games. We use it and the Tanknarok Sample Project to give you an idea of how you can integrate ODIN into an existing, fully functional project. The same principles will of course also work for projets developed with Mirror or Unity Netcode. We’ve even created a guide showing you how to set up a simple Mirror multiplayer game with ODIN integration.

If you’re completely new to ODIN and would like to learn more about our features and what makes us special, take a look at our introduction.

Project Setup

First, we’ll download the base project from the project website. Choose the most up to date version - we’ve used Version 1.1.1 - download and then unzip the project files. We can then open the project using the Unity Hub. Just select Open and navigate to the folder that contains the project files.

Important: You need to select the directory that contains the Assets, Packages and ProjectSettings directories, otherwise the Unity Hub won’t recognize it as a valid project.

Select the Editor version you’d like to use and confirm the Change Editor version? prompt. Please note that ODIN requires Unity version 2019.4 or later, but the Tanknarok project was created in 2020.3.35f1 - so we’ll need to use that or any later version. In this guide we used version 2021.3.9f1.

Create a new project with the Unity Hub.

If you see another prompt Opening Project in Non-Matching Editor Installation, click the Continue button to convert your project.

After opening up, you’ll be greeted by the Welcome to Photon Fusion prompt, asking you to supply your Fusion App Id. This is required for Photon multiplayer to work. Don’t worry, Photon allows a small contingent of 20CCU for test projects, so you won’t be billed anything during development. Open up the Dashboard and select the Create a new app button. When prompted for a Photon Type, select Fusion. Finally, copy the App ID of your newly created Application into the field in the Unity Editor and press enter. You should see a small, green check mark, confirming your successful Fusion setup.

If you’ve accidentally closed the Photon Fusion Hub you can open it up again by selecting Fusion > Fusion Hub from the Unity Editor menus or press Alt+F.

Great - now we’ve got the base project set up, let’s take a look at the interesting stuff: Getting Voice Chat into a game.

ODIN installation

First, let’s install ODIN into our project. ODIN can be imported using either a .unitypackage or by using Unity’s Package Manager and Git. We recommend the package manager, because it is easier to keep ODIN up to date. If you don’t have Git set up, you can still fall back to the Unity package.

Package Manager

Select Window > PackageManager to open up Unity’s Package Manager. In the top left, select the + symbol to add a new package and select Add package from git URL. Use the URL

https://github.com/4Players/odin-sdk-unity.git

and select Add. The Package Manager will now download the newest release and resolve any dependencies.

Unity Package

Download the latest ODIN version as a .unitypackage from https://github.com/4Players/odin-sdk-unity/releases. Use the Assets > Import Package > Custom Package... option and navigate to the downloaded file. Make sure that all Assets are selected and press Import.

Quick Setup

Next, we’ll perform the basic setup for ODIN. Let’s open the MainScene in the directory Assets > Scenes. This is the startup scene in which Fusion lets you choose the Network Modes. This scene will also persist in all other scenes - any lobby or gameplay scenes will be loaded in addition to the main scene.

In this scene we will now add the OdinManager prefab. This prefab contains scripts which handle communication with ODIN servers and allow you to adjust settings. You can find all ODIN files under Packages > 4Players ODIN in the Project Window. Navigate to Packages > 4Players ODIN > Runtime and drag the OdinManager into the scene. Your Scene should now look something like this:

For ODIN to work, we need an Access Key. Select the OdinManager object in the scene and open the Client Authentication drop-down in the Inspector window. ODIN is free to use for up to 25 concurrent users, without requiring an account. Simply press the Manage Access button, click on Generate Access Key and we’re good to go.

We’ll do a quick test to see if everything was set up correctly. Let’s create a new folder ODIN in the Assets directory and then add the new script OdinConnectionTest. This script will contain the following:

Testing the ODIN Connection

public class OdinConnectionTest : MonoBehaviour
{
    [SerializeField] public string roomName;
    void Start()
    {
        OdinHandler.Instance.JoinRoom(roomName);    
    }
}

We use the OdinHandler.Instance singleton to join an ODIN room with the name given by the field roomName. The OdinHandler script is the main entry point for interacting with the ODIN Api, persists through scene changes and can be accessed anywhere in your code by using OdinHandler.Instance.

Every client connects to an ODIN server, authenticates with an access token and joins a room. Once the client has joined a room, they are a peer inside the ODIN room. Every peer can add a media stream to that room to transmit their microphone input. Clients can join multiple rooms at the same time and can add multiple media streams at the same time.

Only clients in the same room can actually hear each other, so you can implement features like a global voice chat for all players and sepearte team voice chats, in which only members of the same team can communicate which each other.

To find more information on the basic ODIN topology, take a look at the Basic Concepts documentation.

For now, we only want to join a room, so the OdinConnectionTest script is enough for our purposes. Let’s create a new empty GameObject in the scene hierarchy and add the OdinConnectionTest component to it. Finally, enter a creative room name (like “Test”) and our test setup is complete. Your project should now look something like this:

To test the project, we’ll need create a Build and run it in parallel to the editor. This way we can test everything on the same computer. Press Ctrl+Shift+B or use the File > Build Settings... menu to show the Build Settings window. Make sure that the MainScene, Lobby, Level1 and Level2 scenes are shown and selected in the build list. Click on Build And Run, select a directory in which your binaries will be created and wait until the Build was started. Switch to the Editor, press play and you should now be able to hear your own voice transmitted via ODIN.

The Build Settings for testing our voice chat locally.

Congratulations, you’ve officially added Voice Chat to a Multiplayer Game! But right now it doesn’t matter where the players are positioned - in fact, we can hear all players in the Start Screen, without having to enter the game. In a real game this would probably become quite chaotic quite fast, so let’s improve that and switch to a Proximity Voice Chat.

Proximity Voice Chat

Joining and leaving

First, let’s remove the TestConnection object from the MainScene, we won’t need it anymore. Instead, we’ll use the Player object itself to control when to join or leave a room. Because the Player object is automatically instantiated in the scenes that should allow Voice Chat - i.e. in the lobby and the gameplay levels - it’s the perfect fit for us.

You can find the Player prefab in Assets > Prefabs > Game > PlayerTank. Let’s create a new script called OdinLocal and add it to the PlayerTank prefab root. This script will from now on handle joining and leaving the room.

Just as before we’ll create a string field to allow us to define the room name and join the ODIN room in Start(), but we’ll also leave the room in OnDestroy(). Now the voice chat will only be active in the lobby and gameplay levels. But because the PlayerTank is instantiated for each player in the scene - both the remote and local players - the JoinRoom function will be called for each player that enters a lobby. We need a way to differentiate between our local player and the remote clients.

We’ll use Fusion’s NetworkObject for this. This behaviour assigns a network identity to a GameObject and allows us to identify players in our game. We get a reference to the NetworkObject and store wether the player is local in our new _isLocal variable by requesting networkObject.HasStateAuthority. This will only be true on the local player. Before joining or leaving a room, we add a check for _isLocal. Your script should look something like this:

Joining as the local player.

using Fusion;
using UnityEngine;

public class OdinLocal : MonoBehaviour
{
    [SerializeField] private string roomName = "Proximity";
    private bool _isLocal;

    private void Start()
    {
        NetworkObject networkObject = GetComponent<NetworkObject>();
        _isLocal = networkObject.HasStateAuthority;
        if(_isLocal)
            OdinHandler.Instance.JoinRoom(roomName);
    }

    private void OnDestroy()
    {
        if(_isLocal)
            OdinHandler.Instance.LeaveRoom(roomName);
    }
}

Playback Prefab

ODIN uses the default AudioSource behaviours to play back incoming voice streams. It seemlessly integrates into the Audio system and allows us to adjust all settings just as we’re used to from Unity. The connection between these so called Media Streams and the AudioSource behaviours is handled by the PlaybackComponent . Until now ODIN has automatically created and destroyed the components. But now we need more control over the AudioSource settings, especially the 3D sound options, which means we have to handle spawning of these behaviours ourselves.

Let’s setup a custom Playback Prefab. Create a new gameobject in your scene hierarchy, call it CustomPlayback and add a PlaybackComponent in the Inspector - an AudioSource will automatically be added. To change the spatial mode of the audio source from 2D to 3D, set the Spatial Blend slider to a value of 1. We can also adjust the 3D Sound Settings - for the Tanknarok we’ve chosen a Min Distance of 2 and a Max Distance 100, but you can of course adjust this and any other settings to your preferred values. Finally, convert the object to a prefab and remove the object from the scene.

Next we need to implement a behaviour that handles the spawning of our Playback objects. We create a new script OdinRemote and add it to the PlayerTank prefab. We set up a reference to our PlaybackComponent prefab and - in the Inspector - drag the previously created prefab into the field. Your PlayerTank prefab should look like this:

Then we start listening to our first Odin event - the OdinHandler.Instance.OnMediaAdded event. OnMediaAdded gets invoked everytime a new Media Stream is added to an ODIN room our player is connected to. In order for the PlaybackComponent to work, it needs a room name, peer id and media id. These three values uniquely identify a Media Stream.

Spawning a playback component.

using Fusion;
using OdinNative.Odin.Peer;
using OdinNative.Odin.Room;
using OdinNative.Unity.Audio;
using UnityEngine;

public class OdinRemote : MonoBehaviour
{
    // Don't forget to set this value
    [SerializeField] private PlaybackComponent playbackPrefab;
    private PlaybackComponent _spawnedPlayback;

    private void Start()
    {
        OdinHandler.Instance.OnMediaAdded.AddListener(MediaAdded);
    }

    private void MediaAdded(object roomObject, MediaAddedEventArgs eventArgs)
    {
        ulong peerId = eventArgs.PeerId;
        long mediaId = eventArgs.Media.Id;
        
        if (roomObject is Room room)
        {
            NetworkObject networkObject = GetComponent<NetworkObject>();
            bool isLocalPlayer = networkObject.HasStateAuthority;

            if(!isLocalPlayer){
                _spawnedPlayback = Instantiate(playbackPrefab, transform);
                _spawnedPlayback.transform.localPosition = Vector3.zero;
                _spawnedPlayback.RoomName = room.Config.Name;
                _spawnedPlayback.PeerId = peerId;
                _spawnedPlayback.MediaStreamId = mediaId;
            }
            
        }
    }
    
    private void OnDisable()
    {
        if (null != _spawnedPlayback)
            Destroy(_spawnedPlayback.gameObject);
    }
}

We retrieve the peer id and the media id from the MediaAddedEventArgs and the room name from the Room object, after casting. It’s important to instantiate the Playback Prefab as a child of the Player object and to reset the local position, to ensure that the AudioSource emits sound from the correct position. We also make sure, that we only spawn Playback components for remote players, we don’t want to listen to the local player’s voice.

Finally, we need disable the automatic playback spawning of the OdinHandler. We have to activate the Manual positional audio setting on our OdinManager object in the scene.

We activate Manual positional audio in our OdinHandler script. — We activate Manual positional audio in our `OdinHandler` script.

Please Note: Some implementation choices in the OdinRemote script are due to the way the Tanknarok project is set up and to keep the code as short and simple as possible. The sample project does not destroy remote player objects, but instead chooses to reuse them when a remote player rejoins a lobby or game. Therefore we keep track of the spawned playback object and destroy it manually in OnDisable.

Identifying players with custom User Data

If we now test this with two players in a room, everything will seem to work. Other player’s voices lower in volume when driving away and we can hear whether a player is on our right or our left. But as soon as a third player enters the room, there’s an issue: because OnMediaAdded gets called for each remote player, our code will instantiate a Playback prefab for each remote player on all remote player objects. We need some way to connect a Media Stream to a Network Object.

ODIN’s custom User Data feature is ideal for handling this situation. Every peer connected to a room has its own user data, which is synchronized over the ODIN servers. We can define our own Data class and use the NetworkObject’s Id to uniquely connect an ODIN peer to an in-game player object. Let’s add our User Data implementation:

Custom User Data implementation.

using OdinNative.Odin;

public class CustomUserData : IUserData
{
    public uint NetworkId;
    
    public override string ToString()
    {
        return JsonUtility.ToJson(this);
    }

    public bool IsEmpty()
    {
        return string.IsNullOrEmpty(this.ToString());
    }

    public byte[] ToBytes()
    {
        return Encoding.UTF8.GetBytes(ToString());
    }
}

The IUserData interface and IsEmpty() and ToBytes() implementations are required for ODIN to be able to transmit our custom data. When the data needs to be transmitted, we simply convert the object to a JSON representation using Unity’s built-in JsonUtility.TJson. For more information on User Data, take a look at our “Understanding User Data” guide.

The important part here is the addition of a NetworkId field. We can now create a new CustomUserData object in our Startmethod, set the NetworkId and supply the user data in our JoinRoom call. The new Start method in the OdinLocal script will now look like this:

Sending custom user data during join.

...
private void Start()
{
    OdinHandler.Instance.OnMediaAdded.AddListener(OnMediaAddedCallback);

    NetworkObject networkObject = GetComponent<NetworkObject>();
    _isLocal = networkObject.HasStateAuthority;
    if (_isLocal)
    {
        CustomUserData roomData = new CustomUserData
        {
            NetworkId = networkObject.Id.Raw
        };
        OdinHandler.Instance.JoinRoom(roomName, roomData);
    }
}
...

The networkObject.Id.Raw uniquely identifies our local player on the network. ODIN will transfer the custom user data and synchronize it to all peers in the same room. This means, we can now read this value in the OdinRemote script. We do this in the MediaAdded callback:

Connecting media streams to players.

...
private void MediaAdded(object roomObject, MediaAddedEventArgs eventArgs)
    {
        ulong peerId = eventArgs.PeerId;
        long mediaId = eventArgs.Media.Id;
        if (roomObject is Room room)
        {
            ulong peerId = eventArgs.PeerId;
            long mediaId = eventArgs.Media.Id;
            if (roomObject is Room room)
            {
                Peer peer = room.RemotePeers[peerId];
                CustomUserData userData = JsonUtility.FromJson<CustomUserData>(peer.UserData.ToString());
                NetworkObject networkObject = GetComponent<NetworkObject>();
                bool isLocalPlayer = networkObject.HasStateAuthority;
                if (!isLocalPlayer && userData.NetworkId == networkObject.Id.Raw)
                {
                    _spawnedPlayback = Instantiate(playbackPrefab, transform);
                    _spawnedPlayback.transform.localPosition = Vector3.zero;
                    _spawnedPlayback.RoomName = room.Config.Name;
                    _spawnedPlayback.PeerId = peerId;
                    _spawnedPlayback.MediaStreamId = mediaId;
                }
            }
        }
...

We first retrieve the Peer object from the rooms RemotePeers array with the peer id. The array contains a list of all remote peers connected to the ODIN room. The peer allows us to access the user data as a generic UserData object, so we need ot convert it into our CustomUserData format, before we can use it. The JsonUtility reads the string representation of the generic object and converts it into our custom format. Finally, we get a reference to the NetworkObject script and compare the Id to the NetworkId stored in the user data object. If it’s equal, we know that the newly added Media Stream belongs to the player object.

What Now?

You’re basically done! After building and opening multiple instances of our game, you can now experience the proximity voice chat you’ve added to the Tanknarok project.

Of course there are a lot of ways we can improve the project. Currently all players will enter the same ODIN room - even if they don’t join the same Multiplayer room! We can fix this by combining the name of the multiplayer room with the ODIN room name we’ve chosen and use the result when joining the room:

Unique room names.

...
string combinedName = networkObject.Runner.SessionInfo.Name + "_" + roomName;
OdinHandler.Instance.JoinRoom(combinedName, roomData);
...

You might also have noticed, that the game’s music and sound effects are kind of loud. We can easily fix this, by navigating to Assets > Audio > Mixer and adjusting the volume settings of the Master, Music or SFX mixers. You could also create a new Audio Group for the in game voice, link it to the Playback Prefab’s AudioSource we created and fine tune the voice chat volume. This way you can also easily implement UI controls to allow players to adjust the volume in-game.

There are also issues that go beyond the scope of this tutorial. You might have noticed, that the direction a voice comes from sometimes does not exactly match what you’d expect. Unity’s Audio system assumes the listener to always be at the location of the AudioListener script. In the Tanknarok sample project, this script is positioned on the CameraParent game object, which represents the position the camera should look at. The position of this object does not always match the player location. To improve this, we’d have to add an AudioListener script to the local players gameobject and deactivate the existing behaviour (Unity requires you to always have only one active AudioListener). If you’d like us to add the solution to this tutorial or have other feedback, let us know on the discord server!

`}),e.add({id:3567,href:"https://www.4players.io/odin/guides/unity/unity-mirror-transport/",title:"ODIN Transport for Mirror Networking",section:"ODIN Documentation",description:"Learn how to use ODIN in combination with Mirror to setup Networking for a P2P Multiplayer game.",content:`

This guide shows how to use the ODIN Transport for Mirror Networking package to provide P2P networking in your Unity games. The ODIN Transport package includes a Transport implementation, allowing Mirror to send and receive data over the 4Players ODIN servers.

ODIN Transport is designed to work in combination with the ODIN Voice Chat service, but can be used without utilizing voice.

What is Mirror?

“Mirror is a system for building multiplayer capabilities for Unity games. It is built on top of the lower level transport real-time communication layer, and handles many of the common tasks that are required for multiplayer games.” Mirror Docs

Mirror takes care of essentials like synchronizing player positions, animations, health and other game variables. It instantiates and destroys game objects across the network and ensures that these objects are managed correctly across the connected clients. It also handles player connections and disconnects and networked scenes.

While Mirror addresses these aspects of networking, it does not handle the actual transmission of data. This is where a transport layer, like the ODIN Transport for Mirror Networking, comes into play.

ODIN’s Role:

Data Transmission: While Mirror organizes and prepares the data for transmission, ODIN is responsible for actually sending and receiving this data over the 4Players ODIN servers.
Scalability and Reliability: By leveraging 4Players servers, ODIN Transport ensures that your multiplayer games can handle a larger number of concurrent players and provide a stable connection.
Voice Chat Integration: When used in combination with ODIN Voice Chat, ODIN Transport seamlessly integrates all kinds of voice communication into your multiplayer games.

In essence, while Mirror lays the groundwork for creating a multiplayer game within Unity, ODIN Transport bridges the gap between the game’s logic and the actual data transmission.

Setup

Install Mirror into your project using the Package Manager. Mirror is available from the Unity Asset Store.
Download the latest ODIN Unity SDK .unitypackage from the Github Releases page and import it into your project.
Download the latest ODIN Transport for Unity SDK .unitypackage from the Github Releases page and import it into your project
Locate the OdinManager_NetworkingVariant prefab in the “Packages/4Players ODIN Transport for Mirror Networking/Prefabs” directory and drop it into your scene.
Select the OdinManager GameObject, click on the Manage Access button under Client Authentication and generate an Access Key. For more information on Access Keys, take a look at our Understanding Access Keys chapter.
Attach a NetworkManager component to a GameObject in your Scene.
Attach a Odin Transport component to the same GameObject as the NetworkManager
Drag the Odin Transport component into the Transport slot on the NetworkManager

For a more in-depth setup guide for ODIN, take a look at our Getting Started with Unity chapter or dive into our Unity video tutorial series.

Connecting

ODIN Transport uses ODIN rooms to handle networking messages. This means instead of entering an IP Address to start or host a client, you provide a room name to the networkAddress field of the NetworkManager. Here’s how you can do it:

Simple Mirror Connection script

public class MinimalMirrorConnection : MonoBehaviour
{
    [SerializeField] private string roomId = "default";
    
    public void StartHost()
    {
        NetworkManager.singleton.networkAddress = roomId;
        NetworkManager.singleton.StartHost();
    }

    public void Connect()
    {
        NetworkManager.singleton.networkAddress = roomId;
        NetworkManager.singleton.StartClient();
    }
}

Note: When going live with your game, ensure you use unique room names. Failing to do so will result in all players connecting to the same networking room.

Using the Positional Audio script

For proximity voice chat functionality in your game, it’s essential to link the incoming voice stream with the corresponding player’s avatar. The ODIN Transport for Mirror package offers a handy utility script called OdinPositionalAudio to streamline this process.

Here’s how to use it:

Attach the OdinPositionalAudio script to the Player-Prefab’s GameObject that has the NetworkIdentity component.
Specify your desired proximity room name in the script.
(optional)

Once these steps are completed, the OdinPositionalAudio script will take care of the rest. When a player connects, the script automatically generates a combined room name using the given proximity room’s name and the networking room’s name. The combination looks like this:

Get proximity room name

public string GetFullPositionalRoomName()
        {
            return $"{positionalRoomName}-{GetNetworkingRoomName()}";
        }

If you’re new to setting up your Player Prefab for multiplayer in Mirror, consult the Mirror Getting Started Guide for a comprehensive walkthrough.

What’s next?

We’ve shown you how to setup Mirror Networking to use ODIN as a Relay Transport. For even more information on Unity with Odin Voice Chat, check out our Discord and take a look at the following guides we’ve prepared for you:

Getting started with ODIN

ODIN and Mirror Networking

`}),e.add({id:3568,href:"https://www.4players.io/odin/guides/unreal/push-to-talk/",title:"Push-To-Talk",section:"ODIN Documentation",description:"Learn how to implement Push-To-Talk functionality in Unreal Engine using the ODIN plugin. This guide provides a step-by-step approach to integrate Push-To-Talk with the Odin Audio Capture object, ensuring a tailored voice chat experience in your multiplayer games.",content:`

In this guide, we’ll cover how to implement Push-To-Talk functionality in the Unreal Engine using the ODIN plugin. This feature is crucial for multiplayer games where players might want to control when they are heard. We’re assuming you already have a working ODIN implementation using the Odin Audio Capture object. If not, take a look at the quick overview below.

By David Liebemann at SciCode Studio.

Creating an Odin Audio Capture

To implement Push-To-Talk functionality, instead of using the default Create Audio Capture method, we’ll use the Create Odin Audio Capture function call. This will create an extended Audio Capture object, that allows us to use the Is Capturing Paused parameter.

The logic for joining an Odin room should look something like this:

Please note, that we store a reference to the Odin Audio Capture object as a variable - we’re going to use it in the next sections.

Understanding Is Capturing Paused

The key to implementing Push-To-Talk in ODIN lies in the Is Capturing Paused parameter of the Odin Audio Capture object. This parameter allows us to control the audio capture state – essentially enabling or disabling the microphone input on demand. It’s important to note that this functionality is specific to the Odin Audio Capture object and is not available in Unreal’s default Audio Capture object.

Warning

We strongly advise against using the Stop Capturing Audio and Start Capturing Audio nodes provided by both Epic’s Audio Capture and the Odin Audio Capture objects. Recent updates, especially from Unreal Engine version 5.3 onwards, have revealed that employing these nodes to stop and start audio capture can lead to application crashes.

Furthermore, even in earlier versions of Unreal Engine, using these nodes has been observed to cause significant performance degradation. This issue stems from Epic’s underlying implementation, which involves destroying and subsequently recreating native audio capture references each time Stop Capturing Audio and Start Capturing Audio are called, respectively.

To ensure optimal performance and stability, especially for features like Push-To-Talk, we recommend utilizing the Is Capturing Paused parameter. This parameter is specifically optimized for such use cases, offering a more efficient and less resource-intensive approach to controlling audio capture in your game.

Setting Up the Input Action

For this guide, we’ll leverage Epic’s Enhanced Input System to define a Push-To-Talk Input Action. If you’re new to the Enhanced Input System, it’s highly recommended to first familiarize yourself with its functionalities by consulting the Unreal documentation.

Here is a step-by-step guide to setting up your Push-To-Talk Input Action using Enhanced Input:

Create Input Mapping Context: If you haven’t already set up an Input Mapping Context in your project, begin by creating a new Input Mapping Context Data Asset. This context will hold your game’s specific input configurations.
Define the Input Action: Next, create a new Input Action Data Asset. Set the Value Type to Digital (bool), which is ideal for binary actions like Push-To-Talk.
Bind the Input Action: Add the newly created Input Action to your Input Mapping Context. For this example, we’ll assign the T key on the keyboard as the control binding for the Push-To-Talk action.
Activate the Input Mapping Context: To ensure your Input Action is recognized and processed, use the Add Mapping Context node in your Player Controller. This action activates the Input Mapping Context containing your Push-To-Talk action.

Info

Note: While this guide focuses on the Enhanced Input System, the Push-To-Talk implementation is also compatible with Unreal’s Legacy Input System. You can adapt this setup to whichever input system your project uses.

Integrating Push-To-Talk in Your Game

Once the Input Action is set up, follow these steps to integrate Push-To-Talk:

Access the Odin Audio Capture object in your game. This should already be part of your existing ODIN setup.
Listen to the Enhanced Input Action event for the PushToTalk action we defined. You can do this in your character or controller blueprint.
In the event, depending on the Action Value (pressed or released), set the Is Capturing Paused parameter of the Odin Audio Capture object.
- If the button is pressed, Is Capturing Paused should be false (unpaused).
- When released, set it to true (paused).
Always check if the OdinAudioCapture object reference is valid before setting the parameter to avoid Null Reference Errors.

Blueprint implementation of Push-To-Talk.

Conclusion

With these steps, you’ve successfully integrated Push-To-Talk functionality in your Unreal Engine game using the ODIN plugin. This will enhance your game’s voice chat experience by giving players control over their microphone input.

For further information on Unreal with Odin Voice Chat, join our community discussions on Discord and explore our additional guides:

Getting started with ODIN

Follow this guide to learn how to install and setup ODIN in your Unreal Project using Blueprint.

Blueprint Reference

Check out our extensive Blueprint reference to learn more about the nodes our SDK provides and how to connect them into your game.

`}),e.add({id:3569,href:"https://www.4players.io/rooms/manual/whiteboard/",title:"Whiteboard",section:"Rooms Documentation",description:"Learn how to use the whiteboard in ODIN Rooms.",content:`

Rooms has a simple and useful Whiteboard included. It allows you to draw basic shapes in different colors and sizes.

Use the Area Controls to reveal the whiteboard.

In the left bottom part of the canvas you’ll notice a toolbar with different tools. Hovering over each button will pop out additional tools to the right side. Click on an icon to activate the tool. From top to bottom:

Undo/Redo: Hovering over this button will reveal the undo and redo buttons. Use these to undo or redo your last action.
Eraser: Use this tool to erase parts of your drawing or clear the whole drawing or just your contributions. You need to have permissions ) to clear the whole drawing.
Drawing Tools: This button reveals available drawing tools. You can either draw lines, rectangles, circles, or freehand.
Color Picker: Use this tool to select a color for your drawing.
Download: Click on this button to download the whiteboard as an image. The image will be downloaded as a PNG file or a SVG file if you have drawn vector graphics.

`}),e.add({id:3570,href:"https://www.4players.io/rooms/manual/",title:"Manual",section:"Rooms Documentation",description:"Explore our comprehensive Rooms guides for getting started and advanced usage.",content:`

Welcome to ODIN Rooms! In this manual the most important features of ODIN Rooms are explained in detail.

User Interface

Learn about the user interface of ODIN Rooms and how to navigate through the different areas.

Text Chat

Learn how to use the text chat in ODIN Rooms.

Whiteboard

Learn how to use the whiteboard in ODIN Rooms.

Permissions

Learn how to set up your audio and video permissions in ODIN Rooms.

`}),e.add({id:3571,href:"https://www.4players.io/rooms/manual/permissions/",title:"Permissions",section:"Rooms Documentation",description:"Learn how to set up your audio and video permissions in ODIN Rooms.",content:`

Rooms does not require user accounts to join a room. However, the owner of the Rooms instance can set up permissions for guests.

Not yet available

This feature is not yet available in the current version of Rooms. It will be available in a future release. Stay tuned!

Guest Permissions

To change guest permissions, you need to be the owner of the Rooms instance. You can change the permissions in the settings of your Rooms instance. To change them, navigate to the URL of your Rooms instance and click on the user icon to reveal the guest permissions.

These settings are available:

Modify App Settings: Allow guests to modify the app settings (like changing the logo or background).
Mute Participants: Allow guests to mute other participants.
Poke Participants: Allow guests to poke other participants. Poking means that the participant will receive a notification which is useful if they are not paying attention or have muted their audio.
Enable Audio: Allow guests to enable or disable their microphone. Disabling that feature will mute the microphone of the guest.
Enable Video: Allow guests to enable or disable their camera. Disabling that feature will turn off the camera of the guest.
Clear Drawings: Allows guests to clear the whiteboard.
Clear Text Chat: Allows guests to clear the text chat.

`}),e.add({id:3572,href:"https://www.4players.io/fleet/manual/deployments/",title:"Setup Deployments",section:"ODIN Fleet Documentation",description:"Learn how to manage deployment settings in ODIN Fleet.",content:`

The Deployment Settings section allows users to manage where and how many server instances are deployed across various locations. This guide will help you navigate the deployment settings, create new deployments, and manage existing ones.

Deployment Overview

Create Config in ODIN Fleet

In the Deployment Settings panel, you will see a map indicating the geographical locations of your deployments and a list of current deployment configurations. Each entry provides the following details:

Region: The geographical region of the deployment.
City: The specific city where the deployment is located.
Name: The name of the deployment configuration.
Server Config: The configuration used for this deployment.
Num Instances: The number of server instances running.
Options: Actions to edit or delete the deployment.

Creating a Deployment

Create Config in ODIN Fleet

To create a new deployment, follow these steps:

Click the Add Deployment button at the top right corner.
In the Create Deployment dialog, fill in the following fields:
- Deployment Name: The name for your deployment.
- Available Locations: Choose from the available locations where the deployment will run.
- Config: Select the server configuration to use.
- Auto Scaler: Choose between manual or automatic scaling (will be available soon)
- Number of Instances: Set the initial number of server instances to run. This can be changed anytime in the dashboard or via script
Click Save to create the deployment.

ODIN Fleet will immediately start deploying the server instances based on the configuration you provided.

Editing a Deployment

To edit an existing deployment:

Click the edit icon (pencil) next to the deployment you want to modify.
In the Edit Deployment dialog, adjust the fields as needed:
- Deployment Name: Update the name of the deployment.
- Available Locations: You cannot change the location of an existing deployment.
- Config: Change the server configuration if needed.
- Auto Scaler: Switch between manual and automatic scaling.
- Number of Instances: Adjust the number of server instances to scale up or down.
Click Save to apply the changes.

ODIN Fleet will update the deployment settings accordingly immediately.

Please note: It’s currently not possible to move a deployment to a different location. If you need to change the location, you will need to create a new deployment and delete the existing one. If you need to move persistent data, you can create a backup of the data, deploy a new server in the desired location, and restore the backup. Reach out to us if you need assistance with this process.

Deleting a Deployment

To delete a deployment:

Click the delete icon (trash can) next to the deployment you want to remove.
Confirm the deletion in the prompt that appears.

Pricing Information

At the bottom of the Add/Edit Deployment dialog, you will see an estimated cost for the deployment based on the selected tier and configuration. This helps you understand the financial impact of your deployments and make informed decisions.

`}),e.add({id:3573,href:"https://www.4players.io/rooms/getting-started/first-call/",title:"Your first call",section:"Rooms Documentation",description:"Learn how to set up your first call in ODIN Rooms.",content:`

In this guide we’ll asume that you have setup your own Rooms instance and that you have a basic understanding of how Rooms works. If you haven’t done this yet, please follow the Getting Started Guide first.

Security Alerts

The first time you join a room, or you open Audio and Video Settings (that’s equally true for all your guests), your browser will ask you for permission to access your microphone and camera. You need to allow this to use audio and video in Rooms. Not doing so will not allow you to use audio and video in Rooms. If you accidentally denied access, you can change this in the settings of your browser.

Before we join the room, let’s make sure that Audio and Video-Settings are correct.

Audio and Video Settings

Before you join a room, you should check your audio and video settings. You can do this by clicking on the sliders icon above the room name input field (see screenshot below).

On the left side of the settings dialog, you can switch between Audio and Video settings. Depending on your permissions (i.e. if you are the owner or as a guest have the permissions) you also see additional settings there.

Audio Settings

Let’s focus on the audio settings first. You should see something like this if you have the audio tap selected:

Audio Input Device: Select the audio input device you want to use. This is usually your microphone. The drop down list contains all available audio input devices. On Windows, this is usually something like “Microphone (Realtek Audio)” or “Microphone (Logitech Webcam)”. On Mac, this is usually something like “Internal Microphone” or “Airpods …”.
Audio Output Device: Select the audio output device you want to use. This is usually your speakers or headphones. The drop down list contains all available audio output devices. On Windows, this is usually something like “Speakers (Realtek Audio)” or " Headphones (Logitech Webcam)". On Mac, this is usually something like “Internal Speakers” or “Airpods …”.
Input Volume: Adjust the input volume of your microphone. This is useful if your microphone is too loud or too quiet. You can adjust the volume by moving the slider to the left or right.
Output Volume: Adjust the output volume of your speakers or headphones. This is useful if the sound is too loud or too quiet. You can adjust the volume by moving the slider to the left or right.
Volume Gate: Rooms automatically tries to avoid that noise from your environment or cheap microphones is transmitted to the other participants. The volume gate is the threshold at which the microphone is activated. If the volume is below the gate, the microphone is muted. If the volume is above the gate, the microphone is activated. You can adjust the volume gate by moving the slider to the left or right.
Automatic Gain Control: If you activate this toggle, Rooms will automatically adjust the volume of your microphone to avoid that you are too loud or too quiet. This is useful if you move around or if you have a cheap microphone that is not very stable in terms of volume.
Voice Activity Detection: If you activate this toggle, Rooms will use AI to identify if you are speaking or not. If you are not speaking, the microphone is muted. This is useful if you have a lot of background noise or if you are in a noisy environment.
Echo Cancellation: If you activate this toggle, Rooms will try to avoid that the sound from your speakers is transmitted back to the microphone. This is useful if you have a cheap microphone or if you have your speakers very loud.
Noise Suppression: If you activate this toggle, Rooms will try to suppress background noise. This is useful if you are in a noisy environment or if you have a cheap microphone.

Video Settings

The next tab are the video settings. Here you can setup the webcam you want to use for video. You should see something like this:

Video Device: Select the video device you want to use. This is usually your webcam. The drop down list contains all available video devices. On Windows, this is usually something like “Logitech Webcam” or “Integrated Webcam”. On Mac, this is usually something like “FaceTime HD Camera” or “Logitech Webcam”.
Start Cam: Click this button to start the selected webcam to verify that it is working correctly.

Browser Permissions

If you use the video settings for the first time, you might only see a “Start Cam” button. Click on that button to initiate the camera. This will trigger the browser to request permission that Rooms is allowed to access your camera. After you gave access, a list will popup with all available cameras.

Creating/Joining a Room

If you have read the Basic Concepts guide, you know that Rooms is organized in rooms. While in other video conferencing tools the primary dimension is time and date, in Rooms it is the room. You can create a room for a specific purpose, like a meeting, a brainstorming session, a game or just to hang out as long as you like.

If your Rooms instance is setup, opening the URL to your Rooms instance (e.g. https://talk.rooms.chat) will show you something like this (depending on weather you have customized your Rooms instance):

In Rooms, we don’t actually create a room, we just join it. If the room does not exist, it will be created automatically by the server, and you will be the first person in the room. If the room already exists, you will join the room and see the other people that are in the room.

Enter a name of the Room you want to join or create and press the “Join Room” button. Some example of room names that we use are coffee-break, we-hate-to-eat-alone, lets-play-a-game, devs, marketing or whatever comes into your mind.

Room Name

Room names are case sensitive and contain any character except for /. So, it’s different if you enter Coffee Breakor coffee break. If you want to have a private conversation, just use a name that is hard to guess, like FE12-GH23-AB45.

For this guide, I have chosen Coffee Break. After joining the room, you will see the user interface of Rooms.

Inviting Others

Once you are in the room, you can invite others to join you. You can do this by sharing the room name with them. You can also create a link to the room and share this link with others. Click on the Copy Invite Link button to copy the link to the clipboard. The link is basically just this format: https://{subdomain}.rooms.chat/{room-name}, so if your instance is talk.rooms.chat and your room is coffee-break, the link would be https://talk.rooms.chat/coffee-break.

Use whatever way you prefer to share the link with others. They just open the link in their Browser, optionally enter their name and join the room.

No Account Required

Users don’t need to create an account to use ODIN Rooms. Users also don’t need to download any software. They just open the URL in their Browser and they are in the room.

Next Steps

That’s it, you have successfully joined your first room in Rooms. You can now start using the room for a quick chat, a brainstorming session, a meeting or just to hang out.

Rooms has many more features, like a whiteboard, a chat, screen sharing and many more. Navigate to our manual to learn more about the features of Rooms.

`}),e.add({id:3574,href:"https://www.4players.io/fleet/manual/servers/",title:"Managing Servers",section:"ODIN Fleet Documentation",description:"Learn how to manage your deployed servers in ODIN Fleet.",content:`

This section of the ODIN Fleet dashboard provides detailed information and controls for managing your deployed servers. You can view all your deployed servers, investigate their settings, monitor their performance, and review their logs. Below is a guide to help you navigate and utilize the server section effectively.

Server Instances

Create Config in ODIN Fleet

The Server Instances panel shows a list of all currently deployed servers. Each entry provides the following information:

Region: The geographical location of the server.
City: The specific city where the server is located.
Server Config: The configuration used for this server instance.
Address: The IP address of the server.
Ports: The ports used by the server.
Date: The date and time the server was deployed.
Status: The current status of the server (e.g., Preparing, Running, Stopped).

You can filter the list of servers by location using the All Locations button.

Click on the small info icon at the right end of each server entry to view more details about that server.

Server Details

Clicking on a server instance will take you to the detailed view of that server. This view consists of several tabs: Info, Stats, and Logs.

Info Tab

Create Config in ODIN Fleet

The Info tab provides basic information and configuration details of the server:

Basic Server Info:
- Id: Unique identifier of the server.
- Server Config: The configuration used for this server.
- Status: The current status of the server (e.g., Starting, Running, Stopped).
Server Location:
- Location: The geographical location and region of the server.
- IP-Address: The IP address of the server.
Backups:
- You can create and manage backups of your persistent data here.
Ports:
- Lists the ports defined in the server configuration, showing the container port and the corresponding published port on the host.
Environment Variables:
- Displays the environment variables set for this server, including static, system, and port variables.

Stats Tab

Create Config in ODIN Fleet

The Stats tab provides real-time performance metrics of the server, including:

CPU Usage: Graph showing the percentage of CPU used over time.
Memory Usage: Graph showing the amount of memory used over time.
Network Ingress: Graph showing the incoming network traffic.
Network Egress: Graph showing the outgoing network traffic.
Disk Read: Graph showing the amount of data read from the disk.
Disk Write: Graph showing the amount of data written to the disk.

Logs Tab

Create Config in ODIN Fleet

The Logs tab displays the log output of the server. You can adjust the settings to control the number of lines displayed and the auto-refresh interval. The logs provide detailed information about the server’s activities, useful for troubleshooting and monitoring.

`}),e.add({id:3575,href:"https://www.4players.io/fleet/manual/ports/",title:"Port Configurations",section:"ODIN Fleet Documentation",description:"Learn how to configure ports for your server in ODIN Fleet.",content:`

Each server that should be accessible from the outside needs to expose ports. Gameservers often have multiple ports doing different things. For example, a game server might have a port for the game itself, a port for the query protocol, and a port for the RCON protocol.

When developing your server, you can just hardcode the port numbers as you like. When we start your server, the runtime will iterate over all the ports that you have configured and find a free port on the host and map the container port to the host port.

graph TD
    Client-->|Connects to Host|Host[Host on port 34727]
    Host-->|Port Mapping|Server
    subgraph Container
        Server[Server on port 7777]
    end

For certain use-cases you need to know inside the server which port is mapped to which service. For example, you might want to tell an external service (i.e. match making or master server for server browser) which port to use to connect to your server.

To do that, you can use environment variables to pass the port numbers to your server. To do that, proceed as follows:

Define the ports in the ports section of the server configuration.
Create a dynamic environment variable for each port that you want to pass to the server and give it a name.

Example

You have defined a Game Port that listens on 7777 (inside the container) via TCP and UDP. Now your gameserver needs to know what the actual outside port is. Create a new dynamic environment variable named GAME_PORT and set the type to Port Mapping and set Game Port as value.

Now you can access the port number inside the server by reading the environment variable GAME_PORT. For example if you use a bash script to write the server configuration file you can use the following code to read the port number:

#!/bin/bash
echo "Game Port is $GAME_PORT"

# Write the server configuration file
echo "GAME_PORT = $GAME_PORT" > /etc/server.cfg

Now, at runtime, the actual outside port has been determined to be 34727 and will be routet to 7777. So the etc/server.cfg you will have the following content:

GAME_PORT = 34727

`}),e.add({id:3576,href:"https://www.4players.io/fleet/manual/steamworks/",title:"Steamworks Integration",section:"ODIN Fleet Documentation",description:"Learn how to integrate Steamworks with ODIN Fleet to create Docker images for your game servers.",content:`

The ODIN Fleet runtime leverages modern container technology to run your game servers. However, not everyone is familiar with creating Docker images from game servers, and many game developers use Steam to distribute client and server files. We created a simple, automated way for you to provide Steamworks details of your server, and we create a Docker image in the background. The image creation process is straightforward and requires only a few steps.

This article explains what happens under the hood once you provide your Steamworks details ( see creating an image for more details).

Steamworks Image Creation Process

Once you have created a Steamworks image, our backend will execute the following steps:

Base Image Setup: We start with an Ubuntu base image and set up the environment for downloading and running the game server. This includes installing essential software and the SteamCMD tool, which is used to download the server files from Steam.
User and Environment Configuration: We create a user named steam and configure the necessary environment variables to ensure the game server runs smoothly. This step ensures that the environment is correctly set up for the game server to operate.
Downloading Steamworks Files: Depending on the platform (Windows or Linux) you specified, we use SteamCMD to download the game server files from Steam. For Windows servers, we use Proton GE, a compatibility tool that allows Windows games to run on Linux. This step ensures that all necessary files are downloaded and ready to be used.
File Organization: All downloaded files from Steamworks are stored in the /gameserver directory within the container. This means any paths referenced in your server’s configuration files should be prefixed with /gameserver. This standardized directory structure simplifies the setup and ensures consistency.
Finalizing the Docker Image: We finalize the Docker image by copying necessary scripts and setting up user permissions. This includes configuring the entrypoint script, which is responsible for starting the game server when the container is run.

Example Usage

To help you understand how to set up your Docker image and server configuration, let’s look at two examples: Enshrouded and Factorio. These examples guide you through the process of creating an image and configuring the server.

Example 1: Enshrouded Server (Simple Settings)

Step 1: Creating the Image

A developer creating an image for Enshrouded would need to provide the following information in the image creation wizard:

Name: enshrouded-server
Version: 1.0
OS: Windows
Steam App ID: 2278520
Branch: public (default)
Executable Command: /gameserver/enshrouded_server.exe

Step 2: Configuring the Server

After creating the image, the developer would need to create a server configuration with the following details:

Basic Configuration:
- Name: Enshrouded Server
- Image: enshrouded-server:1.0
- Restart Policy: Always
Port Settings:
- The developer would add any necessary ports that the server would use to communicate with clients. For example:
  - Name: game
  - Port: 2456
  - Protocol: UDP
Environment Variables:
- The developer might set environment variables if needed. For this example, there would be no additional environment variables required.
Persistent Folders:
- Path in Container: /gameserver/saves
- This would ensure that game saves are persisted across server restarts.

Example 2: Factorio Server (Advanced Settings)

Step 1: Creating the Image

A developer creating an image for Factorio would need to provide the following information in the image creation wizard:

Name: factorio-server
Version: 1.0
OS: Linux
Steam App ID: 427520
Branch: public (default)
**Executable Command **: /gameserver/bin/x64/factorio --start-server /home/steam/save/factorio.zip --server-settings /home/steam/save/server-settings.json
Steamworks Username: <your_steam_account_id>
Steamworks Password: <your_steam_account_password>

Step 2: Configuring the Server

After creating the image, the developer would need to create a server configuration with the following details:

Basic Configuration:
- Name: Factorio Server
- Image: factorio-server:1.0
- Restart Policy: Always
Port Settings:
- The developer would add the necessary ports that the server would use. For Factorio, it typically uses the following:
  - Name: game
  - Port: 34197
  - Protocol: UDP
Environment Variables:
- The developer might set environment variables to configure the server. For example:
  - Name: SERVER_NAME
  - Value: MyFactorioServer
  - Name: MAX_PLAYERS
  - Value: 16
Persistent Folders:
- The developer would ensure that game saves and other important data are persisted across server restarts:
  - Path in Container: /home/steam/save

By following these steps, developers would set up and configure Docker images for their game servers effectively. These examples demonstrate both a simple setup with minimal configuration (Enshrouded) and a more advanced setup with additional parameters (Factorio). Remember, all file paths within the container should be prefixed with /gameserver to ensure proper access and functionality. This approach not only standardizes the game server environment but also provides flexibility to accommodate various game-specific configurations.

Environment Variables

In the server configuration you can use environment variables to make certain aspects of the server configurable. This is especially useful when you want to run multiple instances of the same server with different settings. Of course, your gameserver needs make make use of these environment variables.

Unity

In Unity you would use Environment.GetEnvironmentVariable("SERVER_NAME") to access the value of SERVER_NAME.

Unreal Engine

In Unreal Engine you would use FPlatformMisc::GetEnvironmentVariable(TEXT("SERVER_NAME")) to access the value of SERVER_NAME.

`}),e.add({id:3577,href:"https://www.4players.io/fleet/manual/registries/azure/",title:"Adding an Azure Container Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect an Azure Container Registry to ODIN Fleet, using recommended authentication methods.",content:`

To link your Azure Container Registry (ACR) with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “Azure” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your Azure Container Registry:

Name: Enter a name for this registry connection.
Registry URL: This can be found in the Azure portal under Container registries -> {your_container_registry} -> Overview -> Login server. The format is typically https://YOUR_NAMESPACE.azurecr.io.
Username: Depending on your chosen authentication method, this could be your Azure service principal, the Azure Active Directory (AD) username, or the admin username for your ACR.
Password: Provide the corresponding password for the selected username. For admin accounts, this can be found or set under Access keys in the ACR settings.

Authentication Methods for Azure Container Registry

Azure offers several authentication methods for accessing your container registry:

Admin Account: This is the simplest method. You can enable the admin account in the Azure portal under Container registries -> {your_container_registry} -> Access keys. This method uses the registry’s admin username and password. Learn more.
Repository-Scoped Permissions (Tokens): This method allows for more granular access control. Tokens can be created and managed under Repository Permissions in the ACR settings. This approach is recommended for scenarios requiring limited access to specific repositories. Learn more.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now pull images from your Azure Container Registry directly within ODIN Fleet.

`}),e.add({id:3578,href:"https://www.4players.io/fleet/manual/registries/docker-hub/",title:"Adding a Docker Hub Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect a private docker hub repository to ODIN fleet.",content:`

To link your Docker Hub account with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “Docker Hub” from the options.

3. Provide Required Information

Enter the following details to establish a connection with Docker Hub:

Name: Enter a name for this registry connection.
Username: Enter your Docker Hub username.
Access Token: Provide your Docker Hub access token.

How to create a Docker Hub access token

To generate a Docker Hub access token, visit the Docker Hub website and create a new access token. Ensure that the token has the necessary permissions to pull images from your private repositories. More info can be found in the Docker Hub documentation.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now pull images from Docker Hub directly within ODIN Fleet.

`}),e.add({id:3579,href:"https://www.4players.io/fleet/manual/registries/github/",title:"Adding a GitHub Container Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect a GitHub Container Registry to ODIN Fleet, supporting both personal and organization accounts.",content:`

To link your GitHub Container Registry (also known as GitHub Packages) with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “GitHub” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your GitHub Container Registry:

Name: Enter a name for this registry connection.
Organization: Select “Yes” if you are connecting a GitHub organization account or “No” for a personal account.
Username: Enter your GitHub username.
Access Token: Provide a Personal Access Token (PAT) with the required scopes.

Authentication and Access Tokens

To authenticate with GitHub Container Registry, you’ll need to create a Personal Access Token (PAT) with at least the read:packages scope. Depending on your requirements, you may also need additional scopes like delete:packages or write:packages.

Creating a PAT: Follow GitHub’s official guide on creating a Personal Access Token.
- For personal repositories or organization repositories that support granular permissions, ensure your PAT includes the read:packages scope.
- If your package is in a registry that requires repository-scoped permissions, your PAT must also include the repo scope.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now pull images from your GitHub Container Registry directly within ODIN Fleet.

Additional Resources

`}),e.add({id:3580,href:"https://www.4players.io/fleet/manual/registries/gitlab/",title:"Adding a GitLab Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect a GitLab container registry to ODIN Fleet, supporting both GitLab.com and self-hosted instances.",content:`

To link your GitLab container registry with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “GitLab” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your GitLab container registry:

Name: Enter a name for this registry connection.
Registry URL: For GitLab.com, use https://registry.gitlab.com. For self-hosted instances, use the appropriate registry URL.
Instance URL: For GitLab.com, use https://gitlab.com. If you are using a self-hosted instance, enter its URL.
Username: Provide your GitLab username.
Access Token: Provide an access token with the necessary permissions to access your GitLab registry.

How to create a GitLab access token

To generate a GitLab access token, visit the GitLab Profile Settings and create a new personal access token. Ensure that the token has the necessary scopes (e.g., read_registry) to interact with the container registry. More information can be found in the GitLab documentation.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now pull images from your GitLab container registry directly within ODIN Fleet.

`}),e.add({id:3581,href:"https://www.4players.io/fleet/manual/registries/google-cloud/",title:"Adding a Google Cloud Container Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect a Google Cloud Container Registry (GCR) to ODIN Fleet using the Custom option.",content:`

While ODIN Fleet does not officially support Google Cloud Container Registries (GCR), you can still integrate GCR using the Custom option. This guide will walk you through the necessary steps.

1. Set Up Your Google Cloud Container Registry

Ensure that your GCR is properly set up and that you have the necessary permissions and authentication details. You can find more information on setting up GCR in the Google Cloud Container Registry Documentation.

2. Obtain Your Docker Credentials

Use the gcloud CLI tool to generate a Docker-compatible authentication configuration. Run the following command to authenticate Docker with GCR:

gcloud auth configure-docker

This command updates your Docker configuration to include credentials for GCR, allowing you to pull and push images.

3. Add a New Registry in ODIN Fleet

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

Click the “Add Registry” button and select Custom from the options.

4. Provide Required Information

Enter the following details to establish a connection with your Google Cloud Container Registry:

Name: Enter a name for this registry connection.
Registry URL: Use the GCR registry URL format, which is typically https://gcr.io or a specific regional URL like https://us.gcr.io, https://eu.gcr.io, or https://asia.gcr.io.
Username: Use _json_key or oauth2accesstoken.
Password: Provide the base64-encoded JSON key file content if using _json_key or the OAuth2 access token if using oauth2accesstoken.

Example setup:

Registry URL: https://gcr.io
Username: _json_key
Password: (Paste the base64-encoded content of your service account key file)

Or using OAuth2 access token:

Registry URL: https://gcr.io
Username: oauth2accesstoken
Password: (Your OAuth2 access token)

5. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

Limitations and Warnings

Since this is done via the Custom option, the following limitations apply:

No URL Validation: The provided URL will not be checked for validity or corrected.
No Image Verification: Image existence checks are skipped, meaning ODIN Fleet will not verify if the images exist in the registry.
No Image Browsing: Tagged images will not be retrieved, resulting in an empty list of available images for selection.
Error Handling: If an image cannot be pulled, it will be marked with a status error, but further details may not be provided.

`}),e.add({id:3582,href:"https://www.4players.io/fleet/manual/registries/self-hosted/",title:"Adding a Self-Hosted Docker Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect a self-hosted Docker registry to ODIN Fleet, with full support for image verification and browsing.",content:`

To link your self-hosted Docker registry with ODIN Fleet, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “Self-Hosted Registry” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your self-hosted Docker registry:

Name: Enter a name for this registry connection.
Registry URL: Provide the URL of your self-hosted Docker registry (e.g., https://registry.example.com).
Username: Enter the username required to access your registry.
Password: Provide the password for the username above.

Features and Functionality

ODIN Fleet fully supports self-hosted Docker registries, offering the following convenient features:

Image Name Verification: ODIN Fleet will verify that the image names you use are valid within your self-hosted registry.
Image Browsing: You can browse the available images within the registry directly from the ODIN Fleet interface.
Tagged Images: ODIN Fleet will retrieve and display tagged images from your registry, allowing for easy selection and management.

These features provide a smooth and integrated experience when using a self-hosted Docker registry with ODIN Fleet.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

You can now manage and deploy images from your self-hosted Docker registry directly within ODIN Fleet.

`}),e.add({id:3583,href:"https://www.4players.io/fleet/manual/registries/custom/",title:"Adding a Custom Docker Registry",section:"ODIN Fleet Documentation",description:"Learn how to connect any Docker-compatible registry to ODIN Fleet using the Custom option. Note: This is a fallback option with limited functionality.",content:`

To link a Docker-compatible registry using the Custom option, follow these steps:

1. Access the Docker Registries Section

Navigate to “Settings” in the ODIN Fleet dashboard after selecting/creating your app. In Settings, navigate to the “Docker Registries” tab.

2. Add a New Registry

Click the “Add Registry” button and select “Custom” from the options.

3. Provide Required Information

Enter the following details to establish a connection with your Docker-compatible registry:

Name: Enter a name for this registry connection.
Registry URL: Provide the URL of the registry (e.g., https://YOUR_REGISTRY_DOMAIN).
Username: Enter the username required to access your registry.
Password: Provide the password for the username above.

Limitations and Warnings

The Custom (Other) registry type is intended as a fallback option when no other options are available. It comes with significant limitations:

No URL Validation: The provided URL will not be checked for validity or corrected.
No Image Verification: Image existence checks are skipped, meaning ODIN Fleet will not verify if the images exist in the registry.
No Image Browsing: Tagged images will not be retrieved, resulting in an empty list of available images for selection.
Error Handling: If an image cannot be pulled, it will be marked with a status error, but further details may not be provided.

Use Case

This option is best used for registries that ODIN Fleet does not fully support, such as certain third-party or custom-built Docker registries. It provides a basic level of integration by allowing you to use Docker login credentials but lacks the advanced features available for fully supported registries.

4. Save the Configuration

After entering the necessary details, click “Save” to complete the integration.

Please proceed with caution, as the Custom option provides minimal feedback and functionality compared to fully supported registry types.

`}),e.add({id:3584,href:"https://www.4players.io/fleet/cli/fleet/deployments/",title:"Deployments",section:"ODIN Fleet Documentation",description:"Manage deployments in your account.",content:`

Deployments in Fleet define which server configurations (and therefore which images) are being deployed at which location and with how many instances. You can manage deployments using the CLI.

To create a deployment you will need to have a configuration and an image. You can create these using the CLI or the dashboard. You will also need to provide information about the location. You can use the locations commands to get information about available locations.

Warning

In code, we sometimes refer to deployments as AppLocationSettings. This is the same thing as a deployment. In some data structures (like in Server) we refer to deployments in a appLocationSettingId. We plan to deprecate this terminology in the future.

Overview

The deployments commands allow you to manage deployments of your app. You can create new deployments, list existing deployments, and delete deployments that are no longer needed.

You can have multiple deployments at the same location with different configurations. Each deployment is tied to a specific configuration and location. You can change the number of instances for a deployment, but you cannot change the location afterwards. If you change the configuration, the deployment will be updated to use the new configuration and all server instances will be restarted with the new image.

Usage

odin fleet deployments <command>

Commands

List: List all deployments in your account.
Get: Display detailed information about a deployment.
Create: Create a new deployment.
Delete: Delete a deployment.
Update: Update a deployment

`}),e.add({id:3585,href:"https://www.4players.io/odin/introduction/concepts/",title:"Use cases",section:"ODIN Documentation",description:"Various use cases and how ODIN can help implementing them quickly",content:`

We have compiled a couple of standard use-cases for ODIN and show you which benefits ODIN has to offer. So let’s get started:

Basic concepts

It’s important to understand the basic concept of ODIN:

graph BT
  subgraph ODIN Server
    OR2[Odin Room 1]
    OR[Odin Room 2]        
  end
  subgraph Mobile
    ClientA[Client D] <--> OR
    ClientB[Client C] <--> OR
  end
  subgraph Desktop 
    ClientB[Client C] <--> OR2   
    ClientC[Client B] <--> OR2
  end
  subgraph Consoles*
    ClientD[Client A] <--> OR2
  end

ODIN is a cloud-based client-server application that can easily be integrated into any game or application and even the web. All clients (i.e. users) connected to the same room can chat with all users in that room. Some users may not send any audio and just listening (i.e. spectator). Users also can connect to multiple rooms at the same time and it’s up to you to send audio to all rooms or just one of them.

Multiplayer games

With its 3D positional audio and deep engine integration ODIN is best suited for shooters and battle royal games. But also hide & seek games and many other multiplayer first person or third person games or even virtual reality and augmented reality video conferencing solutions.

Let’s consider a game with these features:

Multiplayer shooter game
Two gameplay modes: Team Based (like in CounterStrike or Rainbow Six Siege) and Deathmatch (last man standing)
Private team chat: All users sharing a team can talk to other team members
World chat. The voice and sound from players should also be “leaked” into the world.
Lobby where players can hang around to find team members and to just chat

Now, we’ll have a look at the network topology of such a game. It might be a bit confusing first, but it’s basically very simple. We hope you read on if we say that you can implement these voice chat features production ready within one day - no registration required!

graph LR
  subgraph ODIN Server
    direction RL
    OR3[Room Lobby]
    OR[Room A_Team_A]        
    OR2[Room A_Team_B]
    World[Room A_World]                                   
    World2[Room B_World]                                   
  end  
  subgraph Team A on GS A
    PlayerB[Player B] <--> OR       
    PlayerB[Player B] <--> World       
    PlayerC[Player C] <--> OR 
    PlayerC[Player C] <--> World 
  end    
  subgraph Team B on GS A
    PlayerE[Player D] <--> World     
    PlayerE[Player D] <--> OR2 
    PlayerF[Player E] <--> World         
    PlayerF[Player E] <--> OR2      
  end      
  subgraph Deathmatch on GS B
    PlayerI[Player F] <--> World2
    PlayerJ[Player G] <--> World2
  end  
  subgraph Lobby
    PlayerH[Player A] <--> OR3
  end      
  subgraph Gameserver Fleet
    GS[Gameserver A] --> PlayerB
    GS[Gameserver A] --> PlayerC
    GS[Gameserver A] --> PlayerE
    GS[Gameserver A] --> PlayerF
    GS2[Gameserver B] --> PlayerI
    GS2[Gameserver B] --> PlayerJ
  end

As you have learned in Basic Concepts all users connected to the same room will be able to talk to anyone else in that room. A room in ODIN is just a string. It can be anything and a room is created dynamically if the first player connects to that room and is deleted once the last user has left the room:

You don’t need to do any book keeping
Figure out a good algorithm to deterministically create a text string out of your game logic so that users that join the same room that should be able to chat together.

In this example, we use the string Lobby for all players running the game but not playing yet. Of course, you could have different rooms within the lobby like Welcome and Finding_Players.

Next, we have players B - E that are playing on Gameserver A in two different teams. For each team, a room has been created which is a string concatenated from the Name of the Gameserver (could be an IP address and Port for example) and the Team Name which is A_Team_A and A_Team_B. Just connect to that room like this and all team members will be able to chat together.

OdinHandler.Instance.JoinRoom("A_Team_A");

The next thing we need to add is the world chat. Check out this image to understand what we mean with that:

In real world, when people talk to other people via headphones, other people around can hear what that person is saying. This is what we mean with “World chat”. You can just connect all players to another room called A_World for the “world” they are in. And now, other players will be able to listen to what you are saying to your team members. So, better don’t scream and make sure nobody is listening.

So, our code would look like this:

OdinHandler.Instance.JoinRoom("A_Team_A");
OdinHandler.Instance.JoinRoom("A_World");

And if someone changes the team, you’d use these two lines:

OdinHandler.Instance.LeaveRoom("A_Team_A");
OdinHandler.Instance.JoinRoom("A_Team_B");

Tip

The team based chat should not be 3D positional audio, because in real world the team members would have headphones on while talking to their team members where volume is always the same. As we have a deep engine integration you can just disabled 3D audio for these audio connections for example with one simple setting in Unity: spatialBlend needs to be 0.0f for these use cases and 1.0f if you want to have 3D audio. That’s just another one line of code to completely change the user experience!

Unity or Unreal do all the heavy lifting of 3D audio calculation for us. Game engines automatically do the 3D spatial audio effects for us. And we can use standard game engine audio features like mixers and DSP to create fancy audio effects like echo (in large rooms) or signal noise to make the players experience even more realistic.

Please note: ODIN can handle thousands of users within a single room and rooms can virtually scale indefinitely and adjust to the games load in real-time. Whatever you are planning. We got you covered. If you are interested in hosting ODIN servers yourself: That’s also possible.

Sounds interesting? Then get started for free and without registration:

MMOs

Massively multiplayer online games are very easy to implement with ODIN. You can have the same network topology as seen above for multiplayer games. As MMOs typically have huge worlds they often have some sort of segmentation.

We’d love to play a game like this:

Space MMO
Every solar system has its own gameserver (for segmentation) and players can jump from one solar system to another via worm wholes (i.e. does not take much time to transfer from one solar system to another)
The clue is, that every player has a radio installed with 5 channels, and they can talk to all other players in that channel - independently of their position in the galaxy.
Players can also call friends in a direct chat.

Let’s have a look at the network topology if this game (radio channels 3 - 5 omitted for clarity):

graph LR
  subgraph ODIN Server
    direction RL
    C1[Room Radio_Channel_1]                                     
    C2[Room Radio_Channel_2]                                   
    DC[Room DirectChat_FG]                                   
  end  
  subgraph In Game
    PlayerH[Player A] <--> C1
    PlayerB[Player B] <--> C1              
    PlayerC[Player C] <--> C1 
    PlayerF[Player D] <--> C2
    PlayerE[Player E] <--> C2                   
    PlayerI[Player F] <--> DC
    PlayerJ[Player G] <--> DC
  end   
  subgraph Gameserver Fleet
    GS[Solar System A] --> PlayerH
    GS[Solar System A] --> PlayerB
    GS[Solar System A] --> PlayerC    
    GS[Solar System A] --> PlayerF
    GS2[Solar System B] --> PlayerE    
    GS2[Solar System B] --> PlayerI
    GS2[Solar System B] --> PlayerJ
  end

As you can see, ODIN is completely independent of your multiplayer topology. This allows you to quickly find the best approach of voice communication within your game without constantly refactoring your client server architecture. ODIN is a pure client side implementation and thus easy to implement!

In the diagram above we have this “game state”:

Players A-D are in Solar System A, while players E-G are in Solar System B.
Players D and E are talking in the same radio, although they are on different game servers and therefore solar systems.
Players A-C talk in radio channel 1.
Players F-G have a direct chat.

Direct Chat

For the direct chat feature we have created a simple room name with DirectChat_FG, which is just a string concatenated from the fixed keyword DirectChat_ and then the ID or name of Players A and Player B. Both players are connected to that room like this (pseudo code):

class Player
{
    private void GetPlayerID()
    {
        return netID;
    }
    
    public void CallPlayer(Player otherPlayer)
    {
        // Join direct chat room
        string roomName = "DirectChat_" + this.GetPlayerID() + otherPlayer.GetPlayerID();
        OdinHandler.Instance.JoinRoom(roomName);
        
        // Signal the client of the other player to join the same room
        otherPlayer.RoomJoinRequest(this, roomName);
    }
    
    public void RoomJoinRequest(Player otherPlayer, string roomName)
    {
        // Show "Ring Notification"
        UI.ShowIncomingCallNotification(otherPlayer.name, roomName);                
    }
    
    public void OnAcceptIncomingCall(string roomName)
    {
        // Signal the client of the other player to join the same room
        OdinHandler.Instance.JoinRoom(roomName);
    }
}

That’s it. It’s as easy as figuring out a good string, connecting to a room and then signaling the other client an incoming call. The other client is showing a UI with a button to accept the call. If accepted the other client joins the same room, and they can talk. Hanging up is just leaving the room!

Radio with different channels

This is easy to do. The Player has a UI where he can set the radio channel. For each radio channel we just create a simple string like Radio_Channel_1 and Radio_Channel_2. When a player changes the radio channel, we just need to leave the current room and connect the other room:

class Radio
{
    private string _currentRadio = null;
    
    public void OnRadioChannelChanged(int channel)
    {
        if (_currentRadio != null) {
            OdinHandler.Instance.LeaveRoom(_currentRadio);
        }
        
        _currentRadio = "Radio_Channel_" + channel.ToString();
        OdinHandler.Instance.JoinRoom(_currentRadio);        
    }      
}

Sounds interesting? Then get started for free and without registration:

Open World

Open world games are awesome, because they give gamers so much freedom, however, those are not so easy to implement. At least the voice part will be very easy to do.

In this example, we have two players running around a huge map. ODIN can handle thousands of users in one room with ease. The deep engine integration of ODIN enables developers to leverage the skills they already have and don’t need to learn something new.

All you have to do is to “through” all players in the same room. ODIN servers know where the players are in 3D space and can route voice packets only to those players that are close enough. This way, CPU on client side is only spent on voice that happens nearby. Network bandwidth is also only used for the necessary audio packets with zero overhead.

Our deep engine integration does not require you to do anything? Just join a room on client side, handle a couple of callbacks and that’s all.

Volume will change with the distance between the players and with headphones or stereo speakers they’ll hear the direction where the other player is. It’s an immersive experience for your players!

Sounds interesting? Then get started for free and without registration:

VR and AR

VR games and applications need to be as immersive and realistic as possible to prevent users from getting motion sick and to feel strange when the headset is on. While this is of course true for graphics, it’s even more important for audio. Headset creators have spent a lot of efforts in creating good headphones and audio solutions for their devices, let’s make use of them!

Voice chat in VR (and to some extend in AR) is even more important than screen based gaming, as typing in VR is an awkward experience and voice is the only way to chat with other people efficiently. And it’s much more immersive, too.

Build virtual conferences, cinemas, multiplayer games and many more with ODIN and real-time 3D audio. In VR, performance is key, and ODIN with its deep engine integration is best suited for these kind of experiences.

Sounds interesting? Then get started for free and without registration:

Virtual Conferences / Metaverse

An important vision these days is the metaverse. The idea is to build virtual spaces that allow people to do everything in the virtual world that they can do in the real world. But without the constraints of the real world. Beaming yourself in seconds to every place you imagine: in our lifetime that will not going to happen, but in virtual world, that’s not an issue at all.

One key feature of the metaverse is audio chats. It’s key and core feature. And spatial 3D audio - i.e. the voice of someone standing nearby is loader than someone else a couple of feet away, and the voice is coming from the direction the person is related to the listener. These are the core features of ODIN and can be implemented in minutes.

The metaverse is the vision, virtual conferences for example is one very good example for that. Surfing web pages on virtual conferences is boring and the feeling of visiting other people and companies is not there. Virtual offices or conferences where people can run around having “virtual physical meetings” is one way to replicate a more physical presence. However, it must be natural. You should be able to chat with everyone you see, but you should also be able to have a discreet one-to-one chat with someone else. And without the hassle of managing contact lists, calling other users and all those complexities that come with standard voice chat tools.

In this example use-case we have built a virtual conference, featuring different rooms. Users are running around and can listen and talk to everyone they see. As it is in the real world.

We use ODINs spatial 3D audio. Every user joining the conference will join a global 3D ODIN room. This way, they can listen to the “noise” of other people talking and listening. Users can of course disable that room if they want to, however, the feeling of presence also includes some sort of noise and randomly hearing other people discussing and talking.

graph BT
  subgraph ODIN Server
    BR[Blue Room]
    YR[Yellow Room]
    FC[Floor Chat]        
    DC[Direct Chat A/B]        
  end
  subgraph Members
    ClientA[Member A] <--> DC    
    ClientB[Member B] <--> DC
    ClientB[Member B] <--> FC   
    ClientD[Member D] <--> YR
    ClientE[Member E] <--> YR
    ClientF[Member F] <--> YR
    ClientG[Member G] <--> FC
    ClientI[Member I] <--> FC
    ClientJ[Member J] <--> FC
    ClientC[Member C] <--> BR
  end

But, there are some benefits that don’t exist in the real world:

Silent direct chats. In noisy environments, it can be hard to have a direct chat. In our virtual world, two (or more) members standing on the floor can join a direct chat. They start talking in the public floor chat, then if they decide to have a private chat, one member invites the other member to join a private conversation, and if the other one agrees, they will join a private randomly created room. Users can still keep their connection to the floor chat (dampened with lower volume) so that they still hear what is going on outside and can react if someone reaches out to them, but they will be able to easily focus on the private conversation.

Next, we have virtual meeting rooms. These are spaces that have a separate ODIN room, that means, whenever you walk into that virtual space, the user will automatically join another ODIN room only available for those people within that virtual space.

Virtual rooms with private audio sessions

In this example, we have that “blue” room and a “yellow” room. Every user walking into that space triggers a collider which then joins the room. Of course you can use ODINs access key feature to only allow specific users to join that room. It will be a secure connection and only those (unlike in the real world) that have the permissions will be able to listen to that chat.

Once users walk out of this space, they leave the ODIN room and will join the global 3D audio room again to participate in the public chat.

You can build these kind of applications with just a couple lines of code (pseudo code!):

class VirtualConferenceMember
{
    public void Start()
    {
        // Join public floor chat
        OdinHandler.Instance.JoinRoom("Floor_Chat");
    }
    
    public void OnTrigger(Collider collider)
    {
        if (collider.collision.direction == Collider.Direction.Entering) {
          // Join private room and leave public "floor" chat
          OdinHandler.Instance.JoinRoom(collider.name);
          OdinHandler.Instance.LeaveRoom("Floor_Chat");
        } else if (collider.collision.direction == Collider.Direction.Exiting) {
          // Leave private room and join public floor chat
          OdinHandler.Instance.LeaveRoom(collider.name);
          OdinHandler.Instance.JoinRoom("Floor_Chat");
        }        
    }      
}

Sounds interesting? Then get started for free and without registration:

Singleplayer games

One use-case for Singleplayer games is “support”. Sometimes players get stuck at specific locations within the game. You can use our Web based framework to integrate ODIN into your web based community like your Forum. Within your game you could place a “Get help” button. If a player clicks on that button, the player will be connected to the same room as community members connected using the web app. The game can also leverage User Data to provide the exact level and location to the community, so they can quickly help! You can even create a simple bot, that listens on OnPeerJoined events and sends a push notification to all community members via web push notifications that are not currently joined to the ODIN room.

graph BT
  subgraph ODIN Server
    OR[Odin Room]        
  end
  subgraph Game
    ClientA[Player A] <--> OR
  end
  subgraph Web App
    ClientB[Community A] <--> OR   
    ClientC[Community B] <--> OR 
    ClientD[Community C] <--> OR
  end
  subgraph Notification
    Script[Bot] <--> OR   
  end

Sounds interesting? Then get started for free and without registration:

Begin ODIN Getting Started Guide

`}),e.add({id:3586,href:"https://www.4players.io/odin/guides/unity/odin-fmod/",title:"FMOD and ODIN",section:"ODIN Documentation",description:"Learn how to integrate ODIN for voice chat functionalities while using the FMOD Audio Solution in Unity. This guide provides step-by-step instructions, code snippets, and best practices to give your users high-quality voice chat with spatial audio in your Unity games.",content:`

Integrating ODIN Voice Chat with the FMOD Audio Solution in Unity.

FMOD and ODIN

Introduction

Welcome to this guide on integrating the ODIN Voice Chat Plugin with the FMOD Audio Solution in Unity. The code used in this guide is available on the ODIN-FMOD Git repository.

What You’ll Learn:

How the FMODMicrophoneReader and FMODPlaybackComponent scripts work and how to use them in your project
Properly set up ODIN in Unity when using FMOD as audio solution
Deal with limitations and potential pitfalls

Warning

Note: This guide assumes that your project has disabled Unity’s built-in audio.

Warning

Disclaimer: Be aware that the implementation shown here uses Programmer Sounds of the FMOD Engine. While this allows real-time audio data, a big disadvantage of this approach is an increased latency by ~500ms.

Getting Started

To follow this guide, you’ll need to have some prerequisites:

Basic knowledge of Unity
The FMOD Plugin for Unity, which you can get here
The ODIN Voice Chat Plugin, available here

To set up FMOD in your project, please follow FMOD’s in-depth integration-tutorial. You can find the tutorial here.

To set up the ODIN Voice Chat Plugin, please take a look at our Getting-Started guide, which you can find here:

FMODMicrophoneReader

The FMODMicrophoneReader script is an essential part of the FMOD integration. It replaces the default ODIN MicrophoneReader component, taking over the microphone input responsibilities by using FMOD. This script is crucial for reading microphone data and sending it to the ODIN servers for voice chat.

You can either follow the Usage setup to drop the FMODMicrophoneReader directly into your project, or take a look at how it works to adjust the functionality to your requirements.

Usage

Add the FMODMicrophoneReader script to your OdinManager prefab.
Disable the original MicrophoneReader component.

The OdinManager prefab after adding the FMODMicrophoneReader and disabling the original MicrophoneReader — The `OdinManager` prefab after adding the `FMODMicrophoneReader` and disabling the original `MicrophoneReader`

Warning

If you’re using ODIN Plugin versions older than 1.5.9, do not remove the MicrophoneReader component, as doing so may lead to NullpointerExceptions.

Info

The script currently doesn’t support automatic device switching or allow for programmatically changing devices. If you’d like to see extensions to this script, feel free to join our Discord server and let us know.

How it works

To read data from the microphone using FMOD, we’ll need to perform the following steps:

Setup and create a FMOD.Sound object, into which FMOD can store the microphone input data.
Start the microphone recording.
Continually read the FMOD microphone data and push it to the ODIN servers

1. Setup

The setup is performed in Unity’s Start() method.

Retrieve Microphone Info

You need to retrieve details about the microphone, such as the sampling rate and the number of channels. We’ll use this info to configure the FMOD recording sound in the next step and the ODIN microphone streams later on.

FMODUnity.RuntimeManager.CoreSystem.getRecordDriverInfo(_currentDeviceId, out _, 0, out _, 
    out _nativeRate, out _, out _nativeChannels, out _);

Configure Recording Sound Info

After obtaining the input device details, the next action is to set up the CREATESOUNDEXINFO object. This object carries essential metadata that FMOD needs for audio capture.

_recordingSoundInfo.cbsize = Marshal.SizeOf(typeof(CREATESOUNDEXINFO));
_recordingSoundInfo.numchannels = _nativeChannels;
_recordingSoundInfo.defaultfrequency = _nativeRate;
_recordingSoundInfo.format = SOUND_FORMAT.PCMFLOAT;
_recordingSoundInfo.length = (uint)(_nativeRate * sizeof(float) * _nativeChannels);

We use SOUND_FORMAT.PCMFLOAT because ODIN requires this format for microphone data. This avoids the need for audio data conversions later on.

The _recordingSoundInfo.length is set to capture one second of audio. To change the recording duration, you can adjust the formula with a different multiplier.

Create Recording Sound

To hold the captured audio, FMOD requires us to create a FMOD Sound object as shown below.

FMODUnity.RuntimeManager.CoreSystem.createSound("", MODE.LOOP_NORMAL | MODE.OPENUSER,
    ref _recordingSoundInfo,
    out _recordingSound);

Here, we use the MODE.LOOP_NORMAL | MODE.OPENUSER flags in combination with the previously configured _recordingSoundInfo to initialize the _recordingSound object.

2. Recording

At this point, we’re ready to start capturing audio. To do so, call the recordStart method from FMOD’s core system.

FMODUnity.RuntimeManager.CoreSystem.recordStart(_currentDeviceId, _recordingSound, true);
_recordingSound.getLength(out _recordingSoundLength, TIMEUNIT.PCM);

After initiating the recording, we also get the length of the recorded sound in PCM samples by calling getLength. This value will help us manage the recording buffer in later steps.

3. Continually push microphone data

In the Update() method, we manage the ongoing capture of audio data from the FMOD microphone and its transmission to the ODIN servers. This ensures that the audio stream remains both current and continuously active.

Initialization

The method starts by checking if there is an active OdinHandler with valid connections and rooms. If not, it returns immediately.

if (!OdinHandler.Instance || !OdinHandler.Instance.HasConnections || OdinHandler.Instance.Rooms.Count == 0)
       return;

The next step is to find out how much audio has been recorded since the last check. This way we know how much data to read from the buffer.

FMODUnity.RuntimeManager.CoreSystem.getRecordPosition(_currentDeviceId, out uint recordPosition);
uint recordDelta = (recordPosition >= _currentReadPosition)
    ? (recordPosition - _currentReadPosition)
    : (recordPosition + _recordingSoundLength - _currentReadPosition);

// Abort if no data was recorded
if (recordDelta < 1)
    return;

If the read buffer is too short to hold the new audio data, its size is updated.

if(_readBuffer.Length < recordDelta)
    _readBuffer = new float[recordDelta];

Read Microphone Data

Microphone data is read from the FMOD sound object and copied into the read buffer using FMODs @lock and the System Marshal.Copy functions.

IntPtr micDataPointer, unusedData;
uint readMicDataLength, unusedDataLength;

_recordingSound.@lock(_currentReadPosition * sizeof(float), recordDelta * sizeof(float), out micDataPointer, out unusedData, out readMicDataLength, out unusedDataLength);
uint readArraySize = readMicDataLength / sizeof(float);
Marshal.Copy(micDataPointer, _readBuffer, 0, (int)readArraySize);
_recordingSound.unlock(micDataPointer, unusedData, readMicDataLength, unusedDataLength);

In this implementation, it’s crucial to be aware of the unit differences between FMOD, ODIN, and the system’s Marshal.Copy function. FMOD expects the read position and read length to be specified in bytes. In contrast, both ODIN and Marshal.Copy require the lengths to be represented as the number of samples being copied. Since we’re recording in the SOUND_FORMAT.PCMFLOAT format, we can use sizeof(float) to easily switch between FMOD’s byte-sized units and ODIN’s sample-sized units.

Push Microphone Data

After reading, if there is any valid data, it is pushed to the ODIN servers and the current microphone read position is updated.

if (readMicDataLength > 0)
{
    foreach (var room in OdinHandler.Instance.Rooms)
    {
        ValidateMicrophoneStream(room);
        if (null != room.MicrophoneMedia)
            room.MicrophoneMedia.AudioPushData(_readBuffer, (int)readArraySize);
    }
}

_currentReadPosition += readArraySize;
if (_currentReadPosition >= _recordingSoundLength)
    _currentReadPosition -= _recordingSoundLength;

The _currentReadPosition is reset back to zero when it reaches the length of the recording buffer to avoid going out of bounds.

The ValidateMicrophoneStream method ensures that an ODIN microphone stream is setup and configured correctly:

private void ValidateMicrophoneStream(Room room)
{
    bool isValidStream = null != room.MicrophoneMedia &&
        _nativeChannels == (int) room.MicrophoneMedia.MediaConfig.Channels &&
        _nativeRate == (int) room.MicrophoneMedia.MediaConfig.SampleRate;
    if (!isValidStream)
    {
        room.MicrophoneMedia?.Dispose();
        room.CreateMicrophoneMedia(new OdinMediaConfig((MediaSampleRate)_nativeRate,
            (MediaChannels)_nativeChannels));
    }
}

By understanding and implementing these steps, you should be able to continually read FMOD microphone data and push it to the ODIN servers, thereby keeping your audio stream up-to-date.

FMODPlaybackComponent

The FMODPlaybackComponent script replaces the default ODIN PlaybackComponent component, taking over the creation and playback of an FMOD audio stream based on the data received from the connected ODIN Media Stream.

You can either follow the setup to use the FMODPlaybackComponent directly in your project, or take a look at how it works to adjust the functionality to your requirements.

Usage

On the OdinHandler script of your OdinManager prefab, switch from Playback auto creation to Manual positional audio.

The OdinHandler’s Manual positional audio setting required for FMODPlaybackComponent to work. — The `OdinHandler`’s `Manual positional audio` setting required for `FMODPlaybackComponent` to work.

In a OnMediaAdded callback, instantiate a new FMODPlaybackComponent and set the RoomName, PeerId and MediaStreamId values based on the MediaAddedEventArgs input, e.g. like this:

...
void Start()
{
    OdinHandler.Instance.OnMediaAdded.AddListener(OnMediaAdded);
    OdinHandler.Instance.OnMediaRemoved.AddListener(OnMediaRemoved);
    ...
}
...
 private void OnMediaAdded(object roomObject, MediaAddedEventArgs mediaAddedEventArgs)
{
    if (roomObject is Room room)
    {
        FMODPlaybackComponent newPlayback = Instantiate(playbackPrefab);
        newPlayback.transform.position = transform.position;
        newPlayback.RoomName = room.Config.Name;
        newPlayback.PeerId = mediaAddedEventArgs.PeerId;
        newPlayback.MediaStreamId = mediaAddedEventArgs.Media.Id;
        _instantiatedObjects.Add(newPlayback);
    }
}

Keep track of the instantiated objects and destroy FMODPlaybackComponent , if the OnMediaRemoved callback is invoked, e.g. like this:

private void OnMediaRemoved(object roomObject, MediaRemovedEventArgs mediaRemovedEventArgs)
{
    if (roomObject is Room room)
    {
        for (int i = _instantiatedObjects.Count - 1; i >= 0; i--)
        {
            FMODPlaybackComponent playback = _instantiatedObjects[i];
            if (playback.RoomName == room.Config.Name 
            && playback.PeerId == mediaRemovedEventArgs.Peer.Id 
            && playback.MediaStreamId == mediaRemovedEventArgs.MediaStreamId)
            {
                _instantiatedObjects.RemoveAt(i);
                Destroy(comp.gameObject);
            }
        }
    }
}

For the full implementation details, take a look at the AudioReadData script on our sample project repository.

How it works

To playback data from the microphone stream supplied by ODIN, we’ll need to perform the following steps:

Setup and create a FMOD.Sound object, into which we’ll transfer the audio data received from ODIN. FMOD will then use the Sound object to playback that audio.
Continually read the ODIN media stream data and transfer it to FMOD for playback.

1. Setup

We perform the setup in Unity’s Start() method.

Setup Playback Sound Info

First, populate the CREATESOUNDEXINFO object with the settings FMOD needs to play back the audio streams correctly.

_createSoundInfo.cbsize = Marshal.SizeOf(typeof(FMOD.CREATESOUNDEXINFO));
_createSoundInfo.numchannels = (int) OdinHandler.Config.RemoteChannels;
_createSoundInfo.defaultfrequency = (int) OdinHandler.Config.RemoteSampleRate;
_createSoundInfo.format = SOUND_FORMAT.PCMFLOAT;
_pcmReadCallback = new SOUND_PCMREAD_CALLBACK(PcmReadCallback);
_createSoundInfo.pcmreadcallback = _pcmReadCallback;
_createSoundInfo.length = (uint)(playBackRate * sizeof(float) * numChannels);

Here, we pull the number of channels and the sample rate from OdinHandler.Config to configure the playback settings. Similar to how the FMODMicrophoneReader operates, we specify the audio format as SOUND_FORMAT.PCMFLOAT. This ensures compatibility between FMOD and ODIN’s sampling units. We also set the playback sound buffer to hold one second’s worth of audio data.

The crucial part of this configuration is setting up the PCM read callback. The PcmReadCallback function is invoked by FMOD whenever it needs fresh audio data, ensuring uninterrupted playback.

Initialize Stream and Trigger Playback

In this case, we opt for the createStream method, which is essentially the createSound function with the MODE.CREATESTREAM flag added.

FMODUnity.RuntimeManager.CoreSystem.createStream("", MODE.OPENUSER | MODE.LOOP_NORMAL, ref _createSoundInfo, out _playbackSound);
FMODUnity.RuntimeManager.CoreSystem.getMasterChannelGroup(out ChannelGroup masterChannelGroup);
FMODUnity.RuntimeManager.CoreSystem.playSound(_playbackSound, masterChannelGroup, false, out _playbackChannel);

To initiate playback, we retrieve the Master Channel Group from FMODUnity.RuntimeManager.CoreSystem and use it along with the stream we’ve just created. Keeping a reference to the returned _playbackChannel allows us to configure the channel for 3D positional audio later on.

2. Read and Playing Back ODIN Audio Streams

The task of fetching audio data from ODIN and sending it to FMOD is accomplished within the PcmReadCallback method.

PCM Read Callback

[AOT.MonoPInvokeCallback(typeof(SOUND_PCMREAD_CALLBACK))]
private RESULT PcmReadCallback(IntPtr sound, IntPtr data, uint dataLength){
    ...
}

To enable calls between native and managed code, we annotate the method with the [AOT.MonoPInvokeCallback(typeof(SOUND_PCMREAD_CALLBACK))] attribute. The callback function is provided with three parameters, of which we only need data and dataLength. These values indicate where to store the ODIN audio data and the number of required samples, respectively.

Data Validation

Next, we include some validation logic:

int requestedDataArrayLength = (int)dataLength / sizeof(float);
if (_readBuffer.Length < requestedDataArrayLength)
{
    _readBuffer = new float[requestedDataArrayLength];
}

if (data == IntPtr.Zero)
{
    return RESULT.ERR_INVALID_PARAM;
}

Similar to our approach in the FMODMicrophoneReader , we use sizeof(float) to switch between the byte-size units used by FMOD and the sample-based units used by ODIN. If needed, we resize the _readBuffer and check the data pointer for validity.

Read ODIN Data and Transfer to FMOD Stream

In the final step, we read the requested amount of samples from the ODIN media stream into _readBuffer. Then we copy this data to FMOD using the provided data pointer.

if (OdinHandler.Instance.HasConnections && !PlaybackMedia.IsInvalid)
{
    uint odinReadResult = PlaybackMedia.AudioReadData(_readBuffer,  requestedDataArrayLength);
    if (Utility.IsError(odinReadResult))
    {
        Debug.LogWarning($"{nameof(FMODPlaybackComponent)} AudioReadData failed with error code {odinReadResult}");
    }
    else
    {
        Marshal.Copy(_readBuffer, 0, data, requestedDataArrayLength);
    }
}

The AudioReadData method pulls the specified amount of data from the PlaybackMedia stream into _readBuffer. We then use ODIN’s Utility.IsError method to verify the operation’s success. If everything checks out, Marshal.Copy is used to transfer the _readBuffer contents to FMOD’s designated playback location in memory, identified by the data pointer.

Accessing the PlaybackMedia

To access a specific ODIN media stream, you’ll need three identifiers: a room name, peer id, and media stream id. You can use these to fetch the media stream with a function like the following:

private PlaybackStream FindOdinMediaStream() => OdinHandler.Instance.Rooms[RoomName]?.RemotePeers[PeerId]?.Medias[MediaStreamId] as PlaybackStream;

The values for RoomName, PeerId, and MediaStreamId can be obtained, for instance, from the OnMediaAdded callback.

FMODPlayback3DPosition

After setting up the basic FMOD playback, you may want to enhance your audio experience by adding 3D positional sound features. The FMODPlayback3DPosition script is designed to handle this.

Usage

To add the 3D audio features to your playback, simply add the component to the same game object your FMODPlaybackComponent is attached to. The FMODPlayback3DPosition behaviour will automatically connect to and setup the playback component, as well as update the 3D position of the FMOD playback channel.

Info

The FMODPlayback3DPosition component currently does not connect to a RigidBody for velocity determination. If a doppler effect is necessary for your project, consider extending the current implementation to automatically access and update the velocity value as well.

How It Works

Setup

To incorporate 3D audio capabilities into your FMOD playback, you’ll need to modify some channel settings. The first step is to ensure that the FMOD Sound and Channel objects are fully initialized by the FMODPlaybackComponent (or a comparable setup).

private IEnumerator Start()
{
    // Wait until the playback component is initialized
    while (!(_playbackComponent.FMODPlaybackChannel.hasHandle() && _playbackComponent.FMODPlaybackSound.hasHandle()))
    {
        yield return null;
    }
    // Initialize 3D sound settings
    _playbackComponent.FMODPlaybackChannel.setMode(MODE._3D);
    _playbackComponent.FMODPlaybackChannel.set3DLevel(1);
    _playbackComponent.FMODPlaybackSound.setMode(MODE._3D);
}

After confirming initialization, we enable 3D audio by applying the MODE._3D flag to both FMODPlaybackChannel and FMODPlaybackSound. Additionally, we set the 3DLevel blend level to 1 to fully engage 3D panning.

Positional Updates

To keep the FMOD sound object’s position in sync with the Unity scene, we fetch the Unity GameObject’s transform and convey its position and rotation to FMOD.

 private void FixedUpdate()
{
    if (_playbackComponent.FMODPlaybackChannel.hasHandle())
    {
        ATTRIBUTES_3D attributes3D = FMODUnity.RuntimeUtils.To3DAttributes(transform);
        _playbackComponent.FMODPlaybackChannel.set3DAttributes(ref attributes3D.position, ref attributes3D.velocity);
    }
}

This approach ensures that the sound source remains spatially accurate within your Unity environment, enhancing the 3D audio experience.

`}),e.add({id:3587,href:"https://www.4players.io/odin/guides/unreal/odin-fmod-unreal/",title:"FMOD and ODIN in Unreal",section:"ODIN Documentation",description:"Learn how to integrate ODIN for voice chat functionalities while using the FMOD Audio Solution in Unreal. This guide provides step-by-step instructions, code snippets, and best practices to give your users high-quality voice chat with spatial audio in your Unreal games.",content:`

Integrating ODIN Voice Chat with the FMOD Audio Solution in Unreal.

FMOD and ODIN

Introduction

Welcome to this guide on integrating the ODIN Voice Chat Plugin with the FMOD Audio Solution in Unreal. The code used in this guide is available on the ODIN-FMOD Sample Project GitHub Repository.

What You’ll Learn:

How the UOdinFmodAdapter script works and how to use it in your project
Properly set up ODIN in Unreal when using FMOD as audio solution
Deal with limitations and potential pitfalls

Warning

Getting Started

To follow this guide, you’ll need to have some prerequisites:

Basic knowledge of Unreal as well as FMOD
The FMOD Plugin for Unreal, which you can get here
The ODIN Voice Chat Plugin, available here

To set up FMOD in your project, please follow FMOD’s in-depth integration-tutorial. You can find the tutorial here.

To set up the ODIN Voice Chat Plugin, please take a look at our Getting-Started guide, which you can find here:

Begin ODIN Getting Started Guide

This guide will show you how to access the Odin Media Stream and copy it to the Audio Input Plugin of FMOD in order to pass it to the FMOD Audio Engine. This means, we will only cover the receiver-side of the communication - the sender just uses Unreal’s Audio Capture Module and thus is handled no different than any other implementation of Odin in Unreal.

Sample Project

You can find a sample project in a repository in our GitHub account. Feel free to download it and set it up in order to view a working integration of this class in a small sample project. This sample is based on the result of the second video of the Odin tutorial Series.

UOdinFmodAdapter

The UOdinFmodAdapter class is an essential part of the FMOD integration. It replaces the default ODIN UOdinSynthComponent component, taking over the voice output responsibilities by using FMOD. This script is crucial for receiving voice chat data from the ODIN servers.

The header can be found here and the source file is located here

The UOdinFmodAdapter inherits from Unreal Engine’s UActorComponent.

You can either follow the Usage setup to drop the UOdinFmodAdapter directly into your project, or take a look at how it works to adjust the functionality to your requirements.

This is the header:

#pragma once

#include "CoreMinimal.h"
#include "FMODAudioComponent.h"
#include "fmod_studio.hpp"
#include "Components/ActorComponent.h"
#include "OdinFmodAdapter.generated.h"

class OdinMediaSoundGenerator;
class UOdinPlaybackMedia;

UCLASS(BlueprintType, Blueprintable, meta = (BlueprintSpawnableComponent))
class ODINTESTPROJECT_API UOdinFmodAdapter : public UActorComponent
{
	GENERATED_BODY()

public:	
	// Sets default values for this component's properties
	UOdinFmodAdapter();

	UFUNCTION(BlueprintCallable, Category = "Odin|Sound")
	void AssignOdinMedia(UPARAM(ref) UOdinPlaybackMedia*& Media);

	FMOD_RESULT pcmreadcallback(FMOD_SOUND* inSound, void* data, unsigned int datalen);

	void DestroyComponent(bool bPromoteChildren) override;

protected:

	UPROPERTY(BlueprintReadOnly, Category = "Odin|Sound")
	UOdinPlaybackMedia* PlaybackMedia = nullptr;
	TSharedPtr<OdinMediaSoundGenerator, ESPMode::ThreadSafe> SoundGenerator;

	float* Buffer = nullptr;
	unsigned int BufferSize = 0;


	FMOD::Sound* Sound = nullptr;
};

And this is the source file of the class:

#include "OdinUnrealSample.h"
#include "fmod_studio.hpp"
#include "FMODStudioModule.h"
#include "odin.h"
#include "OdinFunctionLibrary.h"
#include "OdinMediaSoundGenerator.h"
#include "OdinPlaybackMedia.h"
#include "OdinFmodAdapter.h"

static FMOD_RESULT F_CALLBACK onodinpcmreadcallback(FMOD_SOUND* inSound, void* data, unsigned int datalen)
{
	FMOD::Sound* sound = (FMOD::Sound*)inSound;
	void* userdata;

	sound->getUserData(&userdata);

	UOdinFmodAdapter* instance = reinterpret_cast<UOdinFmodAdapter*>(userdata);

	return instance->pcmreadcallback(inSound, data, datalen);
}

void UOdinFmodAdapter::AssignOdinMedia(UOdinPlaybackMedia*& Media)
{
	if (nullptr == Media)
		return;

	this->SoundGenerator = MakeShared<OdinMediaSoundGenerator, ESPMode::ThreadSafe>();
	this->PlaybackMedia = Media;

	SoundGenerator->SetOdinStream(Media->GetMediaHandle());
}

UOdinFmodAdapter::UOdinFmodAdapter()
{
	PrimaryComponentTick.bCanEverTick = true;

	FMOD::Studio::System* System = IFMODStudioModule::Get().GetStudioSystem(EFMODSystemContext::Runtime);
	FMOD::System* CoreSystem = nullptr;
	System->getCoreSystem(&CoreSystem);

	FMOD_CREATESOUNDEXINFO SoundInfo = { 0 };
	SoundInfo.cbsize = sizeof(FMOD_CREATESOUNDEXINFO);
	SoundInfo.format = FMOD_SOUND_FORMAT_PCMFLOAT;
	SoundInfo.defaultfrequency = 48000;
	SoundInfo.numchannels = 2;
	SoundInfo.pcmreadcallback = onodinpcmreadcallback;
	SoundInfo.length = (unsigned int)(48000 * sizeof(float) * 2);
	SoundInfo.userdata = this;

	if (CoreSystem->createStream("", FMOD_OPENUSER | FMOD_LOOP_NORMAL, &SoundInfo, &Sound) == FMOD_OK)
	{
		FMOD::ChannelGroup* group;
		CoreSystem->getMasterChannelGroup(&group);
		FMOD::Channel* channel;
		CoreSystem->playSound(Sound, group, false, &channel);
	}
}

FMOD_RESULT UOdinFmodAdapter::pcmreadcallback(FMOD_SOUND* inSound, void* data, unsigned int datalen)
{
	if(!data)
		return FMOD_ERR_INVALID_PARAM;

	if (!SoundGenerator || !PlaybackMedia)
		return FMOD_OK;

	unsigned int requestedDataArrayLength = datalen / sizeof(float);

	if (this->BufferSize < requestedDataArrayLength)
	{
		if (nullptr != Buffer)
			delete Buffer;
		Buffer = new float[requestedDataArrayLength];

		BufferSize = requestedDataArrayLength;
	}

	const uint32 Result = SoundGenerator->OnGenerateAudio(Buffer, (int32)requestedDataArrayLength);

	if (odin_is_error(Result))
	{
		FString ErrorString = UOdinFunctionLibrary::FormatError(Result, true);
		UE_LOG(LogTemp, Error, TEXT("UOdinFmodAdapter: Error during FillSamplesBuffer: %s"), *ErrorString);
		return FMOD_OK;
	}

	memcpy(data, Buffer, datalen);

	return FMOD_OK;
}

void UOdinFmodAdapter::DestroyComponent(bool bPromoteChildren)
{
	Super::DestroyComponent(bPromoteChildren);
	if (nullptr != Buffer)
	{
		delete Buffer;
		Buffer = nullptr;
		BufferSize = 0;
	}
}

Remember to adjust the Build.cs file of your game module accordingly. We need to add dependencies to “Odin” obviously, but also “OdinLibrary” is needed for the call to odin_is_error(). From FMOD we need the “FMODStudio” Module in order to work with the FMOD Programmer Sounds. So all in all add these to your Public and Private Dependency Modules:

PublicDependencyModuleNames.AddRange(
	new string[]
	{
        "Core",
        "Odin",
		"OdinLibrary"
	}
	);

PrivateDependencyModuleNames.AddRange(
	new string[] 
	{ 
		"FMODStudio" 
	}
	);

Usage

The above class uses the FMOD Audio Input Plugin to pass dynamically created Audio Data to the FMOD Engine. It does not need any steps in FMOD Studio and will simply work out of the box. All settings are done in the code.

Integrating the Input Component in your Unreal Project

In the next step we will now use the created Component to play back the incoming Odin Media Stream. Again you can find an example of this in the Odin Client Component of the sample project.

First replace the creation of an OdinSynthComponent that you have placed in the Odin Unreal Guide in your project with the new UOdinFmodAdapter.

In the OnMediaAdded event of your Odin implementation in your project you can then call the Assign Odin Media function that we have declared in the C++ class and pass it the reference to the incoming Media Stream.

Like with the OdinSynthComponent, you can also choose to place the UOdinFmodAdapter directly on the Player Character as a component and then reference it in your OnMediaAdded event handler. This way you do not have to create it in the Blueprint and it is easier to change its properties - e.g. its FMOD-specific (attenuation) settings.

You can see a sample of the Blueprint implementation below:

How it works

The above class uses the FMOD Programmer Sound API to pass dynamically created Audio Data to the FMOD Engine. It copies the incoming Audio Stream from Odin to the Input Buffer of the Programmer Sound by FMOD. This is done by creating an FMOD Programmer Sound and implementing a handler for the pcmreadcallback event.

1. Setup

The setup of the UOdinFmodAdapter is done by passing it a reference to the incoming Odin Media Stream. In this guide we have done this via a Blueprint call, but the function can also be called from another C++ Class in your game module.

This function creates a new pointer to a new OdinMediaSoundGenerator and sets its OdinStream to the incoming Media’s handle.

void UOdinFmodAdapter::AssignOdinMedia(UOdinPlaybackMedia*& Media)
{
	if (nullptr == Media)
		return;

	this->SoundGenerator = MakeShared<OdinMediaSoundGenerator, ESPMode::ThreadSafe>();
	this->PlaybackMedia = Media;

	SoundGenerator->SetOdinStream(Media->GetMediaHandle());
}

Next, in the Constructor of the Component we want to create and initialize the FMOD Programmer Sound. We get references to the FMOD Studio’s Core System that is responsible for creating and playing back sounds. With it, we can create the sound for our custom component.

FMOD::Studio::System* System = IFMODStudioModule::Get().GetStudioSystem(EFMODSystemContext::Runtime);
FMOD::System* CoreSystem = nullptr;
System->getCoreSystem(&CoreSystem);

To do so, we create a new SoundInfo and set its fields to what we need for our Odin playback:

SoundInfo.cbsize = sizeof(FMOD_CREATESOUNDEXINFO);
SoundInfo.format = FMOD_SOUND_FORMAT_PCMFLOAT;
SoundInfo.defaultfrequency = 48000;
SoundInfo.numchannels = 2;
SoundInfo.length = (unsigned int)(48000 * sizeof(float) * 2);
SoundInfo.pcmreadcallback = onodinpcmreadcallback;
SoundInfo.userdata = this;

defaultfrequency and numchannels are Odin’s default frequencies but choose any format that you want as long as you also initialize Odin’s sound system with it. The length (in bytes) is not very important, in the example we just use the sample rate and multiply it by the number of bytes per sample and the number of channels to get an effective length of one second.

The last two fields in the example are needed to handle the FMOD event to fill the sound buffer:

The pcmreadcallback needs to point to a static function of your class. Since the function is static, but we want to access the correct Odin SoundGenerator (which is a different one for each object of the class), we need to also pass a pointer to the correct instance of this Actor Component. Since the pcmreadcallback passes a reference to the created FMODSound, we can use its userdata field to pass any needed data. Here we just put a pointer to the ActorComponent that created the sound. Later we will use this to call the function on the correct instance, when the static pcmreadcallback event handler is called.

Lastly we will create the Programmer Sound via the CoreSystem->createStream function. We don’t need to pass it a name, but need to set the FMOD_OPENUSER and FMOD_LOOP_NORMAL flags. The first one is needed to mark the sound as a Programmer Sound, meaning that FMOD will call the pcmreadcallback in order to fill its buffer - this is opposed to other Sounds, where you would pass e.g. a Sound file. The second flag marks the stream as looping, so that the buffer is filled indefinitely. Otherwise the Sound would stop playing, after the number of samples specified in the length field has been played. Additionally we pass the addresses to our SoundInfo and a pointer to the created FMODSound. The latter is set in the function so that we can manipulate it later.

If the creation succeeds, we call the CoreSystem->playSound() function with the just created sound and are good to go!

if (CoreSystem->createStream("", FMOD_OPENUSER | FMOD_LOOP_NORMAL, &SoundInfo, &Sound) == FMOD_OK)
{
	FMOD::ChannelGroup* group;
	CoreSystem->getMasterChannelGroup(&group);
	FMOD::Channel* channel;
	CoreSystem->playSound(Sound, group, false, &channel);
}

2. Reading and Playing Back ODIN Audio Streams

The onodinpcmreadcallback function is called from the FMOD Stduio API whenever the playback requests more data for its buffer.

Since this function needs to be static, we need to get the userdata that we created the sound with and call the proper handler function on the instance that we reference here. We cast the FMOD_SOUND object to an FMOD::Sound (which is exactly the same kind of object but has different functions). On the cast object we can call getUserData() to get the pointer. We just need to reinterpret it as a pointer to a UOdinFmodAdapter component and then we can call its instance function pcmreadcallback with the given parameters from FMOD.

static FMOD_RESULT F_CALLBACK onodinpcmreadcallback(FMOD_SOUND* inSound, void* data, unsigned int datalen)
{
	FMOD::Sound* sound = (FMOD::Sound*)inSound;
	void* userdata;

	sound->getUserData(&userdata);

	UOdinFmodAdapter* instance = reinterpret_cast<UOdinFmodAdapter*>(userdata);

	return instance->pcmreadcallback(inSound, data, datalen);
}

In this function we first check if the component was set up properly and if the incoming parameters are valid.

if (!data)
	return FMOD_ERR_INVALID_PARAM;

if (!SoundGenerator || !PlaybackMedia)
	return FMOD_OK;

The datalength parameter indicates the number of bytes instead of samples, so in order to pass it Odin, we first need to calculate the number of samples from it. Afterwards we create a buffer with the according size or re-create it if the last used one was not big enough. This is then saved in an instance variable Buffer.

unsigned int requestedDataArrayLength = datalen / sizeof(float);

if (this->BufferSize < requestedDataArrayLength)
{
	if (nullptr != Buffer)
		delete Buffer;
	Buffer = new float[requestedDataArrayLength];

	BufferSize = requestedDataArrayLength;
}

Now the UOdinFmodAdapter calls the OnGenerateAudio function of the OdinMediaSoundGenerator. The generated sound is copied into the Buffer.

const uint32 Result = SoundGenerator->OnGenerateAudio(Buffer, (int32)requestedDataArrayLength);

If any error occurs in that call, the function will return without copying anything.

if (odin_is_error(Result))
{
	FString ErrorString = UOdinFunctionLibrary::FormatError(Result, true);
	UE_LOG(LogTemp, Error, TEXT("UOdinFmodAdapter: Error during FillSamplesBuffer: %s"), *ErrorString);
	return FMOD_OK;
}

Lastly, if everything worked as expected we finally copy the data in the Buffer over to the data buffer to pass it to FMOD. The function returns FMOD_OK to let FMOD know it can now use the data buffer.

memcpy(data, Buffer, datalen);

return FMOD_OK;

Conclusion

This simple implementation of an Odin to FMOD adapter for Unreal is a good starting point to give you the control over the audio playback that you need for your Odin Integration in your project. Feel free to check out the sample project in our public GitHub and re-use or extend any code to fit your specific needs.

This is only a starting point of your Odin Integration with FMOD and the Unreal Engine. Feel free to check out any other learning resources and adapt the material like needed, e.g. create realistic or out of this world dynamic immersive experiences with FMOD Spatial Audio aka “proximity chat” or “positional audio”:

`}),e.add({id:3588,href:"https://www.4players.io/odin/guides/unity/user-data/",title:"Understanding User Data",section:"ODIN Documentation",description:"Discover how to synchronize ODIN user data with complex multiplayer frameworks for a seamless gaming experience. Make use of the provided examples to sync game information and voice chat.",content:`

Every peer (players or user connected to an ODIN room) has its own user data. User data within ODIN is always defined like this:

public byte[] UserData { get; set; }

As you can see, it’s just an array of bytes. How you choose to use this is entirely up to you. For example, in simpler games like casual games, board games, or other multiplayer games that don’t require advanced features like movement prediction, you don’t need complex multiplayer frameworks like Mirror Networking or Unity MLAPI to build your game. ODIN’s user data is typically enough, as you can link your custom scripts to the OnPeerUserDataChanged callback, which is triggered whenever user data changes for a connected peer.

If you’re planning to use or are already using one of these more complex frameworks, you’ll need to sync ODIN with those tools, as your players will be connecting to two different servers: the (dedicated) server for the game and ODIN’s backend servers for voice. But don’t worry, it’s simpler than it seems—ODIN’s SDK handles all the heavy lifting for you. In your multiplayer game, players might be on different teams, and only those teams should share the same ODIN room. To synchronize this information between ODIN and your game, you can use UserData.

In our examples, we use a simple class that defines a straightforward structure, serializes it to a JSON string, and sets it as the peer’s user data. Then, on the receiving end, this string is deserialized back into a class instance.

You’ll find this class in the samples folder of the Unity SDK, and it looks like this:

CustomUserDataJsonFormat implementation

using OdinNative.Odin;
using System;
using System.Text;
using UnityEngine;

namespace OdinNative.Unity.Samples
{
    [Serializable]
    class CustomUserDataJsonFormat : IUserData
    {
        public string name;
        public string seed;
        public string status;
        public int muted;
        public string user;
        public string renderer;
        public string platform;
        public string revision;
        public string version;
        public string buildno;

        public CustomUserDataJsonFormat() : this("Unity Player", "online") { }
        public CustomUserDataJsonFormat(string name, string status)
        {
            this.name = name;
            this.seed = SystemInfo.deviceUniqueIdentifier;
            this.status = status;
            this.muted = 0;
            this.user = string.Format("{0}.{1}", Application.companyName, Application.productName);
            this.renderer = Application.unityVersion;
            this.platform = string.Format("{0}/{1}", Application.platform, Application.unityVersion);
            this.revision = "0";
            this.version = Application.version;
            this.buildno = Application.buildGUID;
        }

        public UserData ToUserData()
        {
            return new UserData(this.ToJson());
        }

        public static CustomUserDataJsonFormat FromUserData(UserData userData)
        {
            return JsonUtility.FromJson<CustomUserDataJsonFormat>(userData.ToString());
        }

        public static bool FromUserData(UserData userData, out CustomUserDataJsonFormat customUserData)
        {
            try
            {
                customUserData = JsonUtility.FromJson<CustomUserDataJsonFormat>(userData.ToString());
                return true;
            }
            catch (Exception e)
            {
                Debug.LogException(e);
                customUserData = null;
                return false;
            }
        }

        internal string GetAvatarUrl()
        {
            return string.Format("https://avatars.dicebear.com/api/bottts/{0}.svg?textureChance=0", this.seed);
        }

        public string ToJson()
        {
            return JsonUtility.ToJson(this);
        }

        public override string ToString()
        {
            return this.ToJson();
        }

        public byte[] ToBytes()
        {
            return Encoding.UTF8.GetBytes(this.ToString());
        }
    }
}

If you like this way of handling user data, copy and paste the code into your Unity project, rename it to whatever suits you (and update the namespace). Then, use it to set the user data when joining a room.

Using our CustomUserDataJsonFormat

// Generate a JSON User Data object with the players netId and name in the network
CustomUserDataJsonFormat userData = new CustomUserDataJsonFormat(name, "online");
userData.seed = netId.ToString();

// Join ODIN Room ShooterSample and send user data
OdinHandler.Instance.JoinRoom("ShooterSample", userData.ToUserData());

Feel free to customize the structure to fit the needs of your game.

We have a comprehensive guide on how to leverage UserData to sync ODIN with a multiplayer game created using Mirror Networking .

Integrating ODIN into a multiplayer game created with Mirror

`}),e.add({id:3589,href:"https://www.4players.io/odin/guides/unreal/odin-wwise/",title:"Wwise and ODIN",section:"ODIN Documentation",description:"Learn how to integrate ODIN for voice chat functionalities while using the Wwise Audio Solution in Unreal. This guide provides step-by-step instructions, code snippets, and best practices to give your users high-quality voice chat with spatial audio in your Unreal games.",content:`

Integrating ODIN Voice Chat with the Wwise Audio Solution in Unreal.

Wwise and ODIN

Introduction

Welcome to this guide on integrating the ODIN Voice Chat Plugin with the Wwise Audio Solution in Unreal. The code used in this guide is available on the ODIN-Wwise Sample Project GitHub Repository.

What You’ll Learn:

How the UAkOdinInputComponent script works and how to use it in your project
Properly set up ODIN in Unreal when using Wwise as audio solution
Deal with limitations and potential pitfalls

Getting Started

To follow this guide, you’ll need to have some prerequisites:

Basic knowledge of Unreal as well as Wwise
The Wwise Plugin for Unreal, which you can get here
The ODIN Voice Chat Plugin, available here

To set up Wwise in your project, please follow Wwise’s in-depth integration-tutorial. You can find the tutorial here.

To set up the ODIN Voice Chat Plugin, please take a look at our Getting-Started guide, which you can find here:

Begin ODIN Getting Started Guide

This guide will show you how to access the Odin Media Stream and copy it to the Audio Input Plugin of Wwise in order to pass it to the Wwise Audio Engine. This means, we will only cover the receiver-side of the communication - the sender just uses Unreal’s Audio Capture Module and thus is handled no different than any other implementation of Odin in Unreal.

Sample Project

UAkOdinInputComponent

The UAkOdinInputComponent class is an essential part of the Wwise integration. It replaces the default ODIN UOdinSynthComponent component, taking over the voice output responsibilities by using Wwise. This script is crucial for receiving voice chat data from the ODIN servers.

The header can be found here and the source file is located here

The UAkOdinInputComponent inherits from Audiokinetic’s AkAudioInputComponent from their Audio Input Plugin. As such it must override the methods FillSamplesBuffer and GetChannelConfig to work with the Wwise Audio Engine. There is a tutorial from Audiokinetic on How to use their Audio Input Plugin in Unreal. The script is a customization of that, replacing the usage of the microphone input by Odin’s Voice Media Stream.

You can either follow the Usage setup to drop the UAkOdinInputComponent directly into your project, or take a look at how it works to adjust the functionality to your requirements.

This is the header:

#include "CoreMinimal.h"
#include "AkAudioInputComponent.h"
#include "AkOdinInputComponent.generated.h"

class OdinMediaSoundGenerator;
class UOdinPlaybackMedia;
UCLASS(ClassGroup=(Custom), BlueprintType, Blueprintable, meta=(BlueprintSpawnableComponent))
class MODULE_API UAkOdinInputComponent : public UAkAudioInputComponent
{
    GENERATED_BODY()

public:
    // Sets default values for this component's properties
    UAkOdinInputComponent(const class FObjectInitializer& ObjectInitializer);

    virtual void DestroyComponent(bool bPromoteChildren) override;

    UFUNCTION(BlueprintCallable, Category="Odin|Sound")
    void AssignOdinMedia(UPARAM(ref) UOdinPlaybackMedia *&Media);
    
    virtual void GetChannelConfig(AkAudioFormat& AudioFormat) override;
    virtual bool FillSamplesBuffer(uint32 NumChannels, uint32 NumSamples, float** BufferToFill) override;

protected:
    UPROPERTY(BlueprintReadOnly, Category="Odin|Sound")
    UOdinPlaybackMedia* PlaybackMedia = nullptr;
    TSharedPtr<OdinMediaSoundGenerator, ESPMode::ThreadSafe> SoundGenerator;

    float* Buffer = nullptr;
	int32 BufferSize = 0;
};

And this is the source file of the class:

#include "AkOdinInputComponent.h"
#include "OdinFunctionLibrary.h"
#include "OdinPlaybackMedia.h"

UAkOdinInputComponent::UAkOdinInputComponent(const FObjectInitializer& ObjectInitializer) : UAkAudioInputComponent(
	ObjectInitializer)
{
	PrimaryComponentTick.bCanEverTick = true;
}

void UAkOdinInputComponent::AssignOdinMedia(UOdinPlaybackMedia*& Media)
{
    if (nullptr == Media)
        return;

    this->SoundGenerator = MakeShared<OdinMediaSoundGenerator, ESPMode::ThreadSafe>();
    this->PlaybackMedia = Media;

    SoundGenerator->SetOdinStream(Media->GetMediaHandle());
}

void UAkOdinInputComponent::DestroyComponent(bool bPromoteChildren)
{
	Super::DestroyComponent(bPromoteChildren);
	if (nullptr != Buffer)
	{
		delete Buffer;
		Buffer = nullptr;
		BufferSize = 0;
	}
}

void UAkOdinInputComponent::GetChannelConfig(AkAudioFormat& AudioFormat)
{
    AkChannelConfig ChannelConfig;
	ChannelConfig.SetStandard(AK_SPEAKER_SETUP_STEREO);

	// set audio format
	AudioFormat.SetAll(
		48000, // Sample rate
		ChannelConfig, // \\ref AkChannelConfig
		8 * sizeof(float), // Bits per samples
		sizeof(float), // Block Align
		AK_FLOAT, // feeding floats
		AK_NONINTERLEAVED
	);
}

bool UAkOdinInputComponent::FillSamplesBuffer(uint32 NumChannels, uint32 NumSamples, float** BufferToFill)
{
    if (!SoundGenerator || !PlaybackMedia)
        return false;

    const int32 RequestedTotalSamples = NumChannels * NumSamples;
	if (BufferSize != RequestedTotalSamples)
	{
		if (nullptr != Buffer)
			delete Buffer;
		Buffer = new float[RequestedTotalSamples];
		BufferSize = RequestedTotalSamples;
	}

	const uint32 Result = SoundGenerator->OnGenerateAudio(Buffer, RequestedTotalSamples);
	if (odin_is_error(Result))
	{
		FString ErrorString = UOdinFunctionLibrary::FormatError(Result, true);
		UE_LOG(LogTemp, Error, TEXT("UAkOdinInputComponent: Error during FillSamplesBuffer: %s"), *ErrorString);
		return false;
	}

	for (uint32 s = 0; s < NumSamples; ++s)
	{
		for (uint32 c = 0; c < NumChannels; ++c)
		{
			BufferToFill[c][s] = Buffer[s * NumChannels + c];
		}
	}


	return true;
}

Remember to adjust the Build.cs file of your game module accordingly. We need to add dependencies to “Odin” obviously, but also “OdinLibrary” is needed for the call to odin_is_error(). From Wwise we need the “AkAudio” and “Wwise” Modules in order to work with the Audio Input Plugin. So all in all add these to your Public Dependency Modules:

PublicDependencyModuleNames.AddRange(
	new string[]
	{
        "Core",
        "Odin",
        "AkAudio",
        "Wwise",
		"OdinLibrary"
	}
	);

Usage

The above class uses the Wwise Audio Input Plugin to pass dynamically created Audio Data to the Wwise Engine. So we will need to set this up in the Wwise Authoring Tool and then use the class in your Game Logic properly.

Creating a Wwise Event

To provide Unreal with the correct Wwise Event you need to add an Audio Input Plugin Source to your Soundbank. An example of this can be found in the sample project. To achieve this, you can follow these steps:

In the “Audio” tab of the Project Explorer right-click on the wanted work unit of the “Actor-Mixer-Hierarchy” and add a “New Child->Audio Input”.

Make adjustments to it like needed in your project.
Make sure to go to the “Conversion” tab in the Contents Editor and set the Conversion to “Factory Conversion Settings->PCM->PCM as Input” by clicking on the “»” button.

Right-click the newly created source and add a “New Event->Play” to it.

Lastly you need to add that event to the Soundbank by dragging it from the “Events” tab in the Project Explorer to the Soundbank’s Content Editor.

Export using the Wwise Browser like described in Audiokinetic’s Guide in Unreal and you are good to go!

Integrating the Input Component in your Unreal Project

In the next step we will now use the created event to play back the incoming Odin Media Stream. Again you can find an example of this in the Odin Client Component of the sample project.

First replace the creation of an OdinSynthComponent that you have placed in the Odin Unreal Guide in your project with the new AkOdinInputComponent.

In the OnMediaAdded event of your Odin implementation in your project you can then set the AkAudioEvent of the created AkOdinInputComponent to the Wwise Event that we imported earlier. Call the Assign Odin Media function that we have declared in the C++ class and pass it the reference to the incoming Media Stream and lastly call PostAssociatedAudioInputEvent. It is important to use that function from the AkAudioInputComponent since any other “Post Event” function will not work with the Wwise Audio Input Plug-in. You can see a sample of the Blueprint implementation below:

Like with the OdinSynthComponent, you can also choose to place the AkOdinInputComponent directly on the Player Character as a component and then reference it in your OnMediaAdded event handler. This way you do not have to create it in the Blueprint and it is easier to change its properties - e.g. its Wwise-specific (attenuation) settings.

How it works

The above class uses the Wwise Audio Input Plugin to pass dynamically created Audio Data to the Wwise Engine. It copies the incoming Audio Stream from Odin to the Input Buffer of the Audio Input Component by Wwise. This is done by inheriting from the UAkAudioInputComponent and overriding the respective methods.

1. Setup

The setup of the UAkOdinInputComponent is done by passing it a reference to the incoming Odin Media Stream. In this guide we have done this via a Blueprint call, but the method can also be called from another C++ Class in your game module.

This method creates a new pointer to a new OdinMediaSoundGenerator and sets its OdinStream to the incoming Media’s handle.

Next, the Wwise Audio Input Plug-In asks for the Channel Configuration, calling GetChannelConfig (this is done from the Wwise Audio Engine, so we do not need to take care of calling this function). Here we set the Audio Format of the AkAudioComponent to a new format with 48k sample rate and non-interleaved floats.

2. Reading and Playing Back ODIN Audio Streams

The FillSamplesBuffer function is called from the Wwise Audio Input Plug-in whenever the playback requests more data for its buffer.

Here the AkOdinInputComponent calls the OnGenerateAudio function of the OdinMediaSoundGenerator. The generated sound is copied into the Buffer.

If any error occurs in that call, the function will return without copying anything and tell the Wwise Audio Plugin that it failed to capture more samples.

Since Wwise only accepts float samples only as non-interleaved data (see here for reference) and the OdinMediaSoundGenerator provides it as interleaved, we need to sort it accordingly into the BufferToFill. This is done with the nested for-loops at the end of the function.

Lastly, if everything worked as expected the function returns true to let Wwise know it can now use the BufferToFill.

Conclusion

This simple implementation of an Odin to Wwise adapter for Unreal is a good starting point to give you the control over the audio playback that you need for your Odin Integration in your project. Feel free to check out the sample project in our public GitHub and re-use or extend any code to fit your specific needs.

This is only a starting point of your Odin Integration with Wwise and the Unreal Engine. Feel free to check out any other learning resources and adapt the material like needed, e.g. create realistic or out of this world dynamic immersive experiences with Wwise Spatial Audio aka “proximity chat” or “positional audio”:

`}),e.add({id:3590,href:"https://www.4players.io/odin/introduction/comparison/",title:"Comparison",section:"ODIN Documentation",description:"Learn how ODIN compares to the competition",content:`

ODIN has been built from scratch by industry leading voice engineers with your privacy and security in mind. In addition, ODIN provides the following key features:

Ultra-low latency and extremely low resource usage
Best-in-class voice quality with noise suppression
Built-in data protection and fully GDPR compliant
Support for thousands of concurrent users chatting at the same time with native 3D spatial audio support
Deep Unity and Unreal Engine integration
Zero maintenance and operations for clients but support for self-hosting if they want to (for sensitive areas)

This table should give you an overview how ODIN compares to other solutions.

Feature	ODIN	Photon	TeamSpeak	Agora	Vivox	EOS
Hosting & Pricing
Cloud hosting Let us deal with the setup, administration and bandwidth costs. ODIN leverages worldwide production-ready and battle-tested server infrastructure from 4Netplayers, who have been providing voice and game servers for more than 20 years.	✔	✔	✕	✔	✔	✔
Let us deal with the setup, administration and bandwidth costs. ODIN leverages worldwide production-ready and battle-tested server infrastructure from 4Netplayers, who have been providing voice and game servers for more than 20 years.
Self hosting ODIN infrastructure can be hosted on-premise. Run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. ODIN comes with Docker support for easy deployment wherever needed.	✔	✔	✔	✕	✕	✔
ODIN infrastructure can be hosted on-premise. Run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. ODIN comes with Docker support for easy deployment wherever needed.
Traffic included Traffic costs can grow significantly if voice chat is used heavily or by many users and it’s hard to estimate those costs. Every month will have its surprise day when you get your invoice. Deals made for 4Netplayers with cloud and server providers all over the world allow us to include traffic costs in all our tiers. No hidden or hard to estimate costs for you.	✔	✕	✕	✕	✔	✔
Traffic costs can grow significantly if voice chat is used heavily or by many users and it’s hard to estimate those costs. Every month will have its surprise day when you get your invoice. Deals made for 4Netplayers with cloud and server providers all over the world allow us to include traffic costs in all our tiers. No hidden or hard to estimate costs for you.
Users per room How many users can join the same room to talk together. MMORPGs or larger battle royal games should be able to bring hundreds of users together. There is no limit for users per room at ODIN. However, there is a technical limit that depends on the implementation (i.e. a lot of voice communication, or more text and simple data). 2000 users should be no issues at all.	2000+	50	1000	128		16
How many users can join the same room to talk together. MMORPGs or larger battle royal games should be able to bring hundreds of users together. There is no limit for users per room at ODIN. However, there is a technical limit that depends on the implementation (i.e. a lot of voice communication, or more text and simple data). 2000 users should be no issues at all.
Platform & Engine Integration
Deep Unity Integration ODIN provides a full-featured Unity SDK and leverages Unity’s audio processing pipeline for capture and playback. Developers work with Unity tools they know like AudioSource and AudioMixers and get 3D positional audio automatically. ODIN fully integrates into more advanced 3D audio solutions and comes with a couple of examples and scripts for easy integration of different materials and their damping effects (like glass or concrete).	✔	✔	✕	✔	✕	✕
ODIN provides a full-featured Unity SDK and leverages Unity’s audio processing pipeline for capture and playback. Developers work with Unity tools they know like AudioSource and AudioMixers and get 3D positional audio automatically. ODIN fully integrates into more advanced 3D audio solutions and comes with a couple of examples and scripts for easy integration of different materials and their damping effects (like glass or concrete).
Deep Unreal Engine Integration Many voice SDKs are just a wrapper around browser based WebRTC libraries. ODIN offers native Unreal Engine (UE4 & UE5) support with simple to use Blueprint support for easy and reliable voice integration. Use the tools you know within the Unreal Engine.	✔	✔	✕	✕	✕	✔
Many voice SDKs are just a wrapper around browser based WebRTC libraries. ODIN offers native Unreal Engine (UE4 & UE5) support with simple to use Blueprint support for easy and reliable voice integration. Use the tools you know within the Unreal Engine.
Unreal Engine 5 support Unreal Engine 5 is best suited for large open-world games. This requires a reliable voice technology for as many users. ODIN is a great fit and offers full Unreal Engine 5 support.	✔	✕	✕	✕	✕	✔
Unreal Engine 5 is best suited for large open-world games. This requires a reliable voice technology for as many users. ODIN is a great fit and offers full Unreal Engine 5 support.
Web Support ODIN is available for the web as vanilla JavaScript script or `npm` package and can be integrated into websites or apps built with web technologies (like Angular, Vue, React, ReactNative, Svelte, …) in a couple of minutes. ODIN cross-platform compatibility allows users to interact (i.e. chat, realtime data synchronization) with each other independently where they are. Think about users talking within a CRM tool with users running in a virtual VR shopping center. All this is possible with ease with ODIN.	✔	✕	✕	✔	✕	✕
ODIN is available for the web as vanilla JavaScript script or `npm` package and can be integrated into websites or apps built with web technologies (like Angular, Vue, React, ReactNative, Svelte, …) in a couple of minutes. ODIN cross-platform compatibility allows users to interact (i.e. chat, realtime data synchronization) with each other independently where they are. Think about users talking within a CRM tool with users running in a virtual VR shopping center. All this is possible with ease with ODIN.
Swift SDK Apple developers are picky about their tools as they are used to work with the best tech. Our Swift SDK offers a quick and easy integration into the Apple eco-system. The SDK comes with Playgrounds to learn the SDK very quickly and integrates seamlessly with AVAudioEngine.	✔	✕	✕	✔	✕	✕
Apple developers are picky about their tools as they are used to work with the best tech. Our Swift SDK offers a quick and easy integration into the Apple eco-system. The SDK comes with Playgrounds to learn the SDK very quickly and integrates seamlessly with AVAudioEngine.
Core Communication Features
Native Spatial Audio Spatial audio is a feature that allows users to experience enhanced immersion and a sense of presence by creating a 3D soundscape that reflects the positions and movements of the participants within a virtual environment. This can help to create a more engaging and realistic experience for users, as the sound seems to be coming from the direction of the speaker, rather than from a fixed position in the room.	✔	✕	✔	✔	✔	✕
Spatial audio is a feature that allows users to experience enhanced immersion and a sense of presence by creating a 3D soundscape that reflects the positions and movements of the participants within a virtual environment. This can help to create a more engaging and realistic experience for users, as the sound seems to be coming from the direction of the speaker, rather than from a fixed position in the room.
Client-Server There are two basic networking topologies possible: Peer to Peer and Client-Server. In peer to peer solutions there is no central hub but each user must send his data to each other user. Data traffic grows exponentially with each additional user and does not work for more than 4 users reliable. Not considering issues with firewalls, NAT and many other shortcomings. Client-server software has a central hub and can handle thousands of users.	✔	✔	✔	✔	✔	✔
There are two basic networking topologies possible: Peer to Peer and Client-Server. In peer to peer solutions there is no central hub but each user must send his data to each other user. Data traffic grows exponentially with each additional user and does not work for more than 4 users reliable. Not considering issues with firewalls, NAT and many other shortcomings. Client-server software has a central hub and can handle thousands of users.
Latest technology Most voice SDKs are built on top of WebRTC. WebRTC is a monstrous library to manage all sorts of real-time communication into browsers. WebRTC is a very old and very complex piece of software. ODIN is built from scratch on latest tech like HTTP3/QUIC on a proprietary protocol that is developed with deep game engine integration and spatial 3D audio support in mind.	✔	✔	✕	✕	✕	✕
Most voice SDKs are built on top of WebRTC. WebRTC is a monstrous library to manage all sorts of real-time communication into browsers. WebRTC is a very old and very complex piece of software. ODIN is built from scratch on latest tech like HTTP3/QUIC on a proprietary protocol that is developed with deep game engine integration and spatial 3D audio support in mind.
Multi-room support Voice solutions typically use a room or channel based approach where all users connected to the same room or channel can talk to each other. Some use-cases require users to be able to join multiple rooms at the same time. ODIN comes with native multi-room support. Every user can join as many rooms as they like. There can be a 3D positional audio chat that mimics real voice and in addition to that users can have a walkie-talkie to talk to users that are out of reach. You can also define rooms that are just used to real-time data synchronization.	✔	✕	✔	✔	✔	✕
Voice solutions typically use a room or channel based approach where all users connected to the same room or channel can talk to each other. Some use-cases require users to be able to join multiple rooms at the same time. ODIN comes with native multi-room support. Every user can join as many rooms as they like. There can be a 3D positional audio chat that mimics real voice and in addition to that users can have a walkie-talkie to talk to users that are out of reach. You can also define rooms that are just used to real-time data synchronization.
Intrinsic data protection ODIN is completely stateless. The authentication works with a single token created by you per user and room that stores everything required for the service. This token is not stored anywhere in the ODIN infrastructure. Rooms are automatically created once the first user joins the room and are deleted once the last user left the room. There is no database in the background. ODIN does not collect or store any data at all.	✔	✕	✕	✕	✕	✕
ODIN is completely stateless. The authentication works with a single token created by you per user and room that stores everything required for the service. This token is not stored anywhere in the ODIN infrastructure. Rooms are automatically created once the first user joins the room and are deleted once the last user left the room. There is no database in the background. ODIN does not collect or store any data at all.
Real-time data synchronization ODIN allows developers to sync data per user and per room in real-time. Whenever something changes in this data-set, it’s synced with all other users connected to the same room in real-time. You can sync the players positions in real-time (i.e. geolocation in met averse applications) or a text-chat-history in a room with easy.	✔	✔	✕	✕	✕	✔
ODIN allows developers to sync data per user and per room in real-time. Whenever something changes in this data-set, it’s synced with all other users connected to the same room in real-time. You can sync the players positions in real-time (i.e. geolocation in met averse applications) or a text-chat-history in a room with easy.

`}),e.add({id:3591,href:"https://www.4players.io/odin/introduction/projects/",title:"Projects and namespaces",section:"ODIN Documentation",description:"Understanding the relation between projects and access keys in 4Players ODIN for using namespaces.",content:`

TL;DR

All clients that need to talk to each other have to join the ODIN room with the same name in the same namespace.

Hosting type

Managed

With ODIN managed cloud hosting, for each subscription, you have an individual project with an infinite number of access keys ( see Understanding Access Keys ). Each project then represents its own room namespace where people can talk to each other.

On-Premise

When using an ODIN on-premise server, in combination with an ODIN gateway for easy scalability, you can configure everything the way you need it. You can assign namespaces on either a customer level or for each individual access key.

Organizing your projects

As an active subscriber you can manage your projects here:

Go to ODIN Dashboard

There you can manage your keys for all the cloud hosted projects you currently have. Keys for on-premise projects you can manage in your own configuration files.

Separating rooms by project

Each project has his own namespace. If in both projects there is a room named “lobby”, users from one project will not be able to talk to users from the other project, even if both users joined a room named “lobby”.

graph TD
    subgraph ODIN Clients
        subgraph Project 1
            C1[Client 1]
        end
        subgraph Project 2
            C2[Client 2]
        end
    end

    C1 -->|Yes| R1
    C2 -->|Yes| R2
    C2 -.->|No| R1
    
    subgraph ODIN Server
        subgraph Project 1
            R1["Room #quot;lobby#quot;"]
        end    
        subgraph Project 2
            R2["Room #quot;lobby#quot;"]
        end
    end
    
    R1 -.-|cannot talk to each other| R2

Separating rooms within one project

You can also keep things simple and separate users by choosing special room IDs in the same namespace, e.g. “lobby_server1” and “lobby_server2”. But depending on where your room tokens are generated (server-side or client-side) or if clients are able to decide themselves, which room ID to use for joining, you will have to make compromises with security.

graph TD
    subgraph ODIN Clients
        subgraph Project 1
            C1[Client connected to server 1]
            C2[Client connected to server 2]
        end
    end
    
    subgraph ODIN Server
        subgraph Project 1
            R1["Room #quot;lobby_server1#quot;"]
            R2["Room #quot;lobby_server2#quot;"]
        end
    end
    
    C1 -->|Yes| R1
    C2 -->|Yes| R2
    C1 -->|should not| R2

    R1-.-|cannot talk to each other| R2

`}),e.add({id:3592,href:"https://www.4players.io/fleet/sdk/",title:"SDKs",section:"ODIN Fleet Documentation",description:"Explore our easy-to-use SDKs for NodeJS. Download and follow our guides to seamlessly integrate ODIN Fleet into your projects, with minimal development overhead.",content:`

We provide easy to use SDKs for Unity and Unreal and the Web. Download and install the SDK and follow one of our guides and you’ll have ODIN integrated in no time.

Please choose your platform to start with implementation:

NodeJS

Deeply integrate ODIN Fleet into your CI/CD workflows and automate game server deployment and management with our NodeJS SDK.

REST

Learn more about our underlying REST-API and how to consume it.

`}),e.add({id:3593,href:"https://www.4players.io/odin/sdk/",title:"SDKs",section:"ODIN Documentation",description:"Explore our easy-to-use SDKs for Unity, Unreal, Web, Swift, and NodeJS. Download and follow our guides to seamlessly integrate ODIN Voice Chat into your projects, with minimal development overhead.",content:`

We provide easy to use SDKs for Unity and Unreal and the Web. Download and install the SDK and follow one of our guides and you’ll have ODIN integrated in no time.

Please choose your platform to start with implementation:

Unity

Use our deep Unity integration to add the most immersive in-game voice chat to your product with minimal development overhead.

Unreal Engine

Our upcoming Unreal Engine plugin will feature full support for all available platforms and come with Blueprint and C++ support.

Web Browser

Our NPM package will feature full real-time communication support for all major web browsers including voice activity dectection.

Swift

Integrate OdinKit into your iOS and macOS apps and add real-time voice communication in a couple of minutes and with zero maintenance or operations.

NodeJS

Build AI enhanced human-like chatbots, NPCs and advanced features like automatic content moderation, translation and recording with our NodeJS SDK.

Core API

ODIN native client library is built with Rust. It provides a standard C API that can easily be implemented into any application, framework or platform. For many well-known and well-beloved platforms and game engines we have created customized and easy to use SDKs and Frameworks based on the Core API.

`}),e.add({id:3594,href:"https://www.4players.io/fleet/cli/fleet/servers/",title:"Servers",section:"ODIN Fleet Documentation",description:"Learn how to work with ODIN Fleet servers using the CLI.",content:`

Servers in Fleet are the instances that run your game servers and services. This guide will show you how to manage servers in your ODIN Fleet account using the CLI.

You can also manage servers using the dashboard including viewing logs, detailed stats, restarting servers, and more.

Please note

In Fleet, you don’t create servers directly. Instead, servers are created automatically when you create a deployment or if you modify the number of instances in a deployment.

Overview

The servers commands allow you to manage servers in your account. You can list all servers, get detailed information about a specific server, and restart servers that are not functioning correctly.

Usage

odin fleet servers <command>

Commands

List: List all servers in your account.
Get: Display detailed information about a server.
Restart: Restart a server.
Logs: View logs for a server.
Backup: Create a backup of a server.
Restore: Restore a server from a backup.

`}),e.add({id:3595,href:"https://www.4players.io/odin/introduction/access-keys/",title:"Understanding Access Keys",section:"ODIN Documentation",description:"Learn how to manage your keys for accessing 4Players ODIN",content:`

An access key is your unique authentication key to be used to generate room tokens for accessing the 4Players ODIN server network. Think of it as your individual username and password combination all wrapped up into a single non-comprehendable string of characters, and treat it with the same respect.

Important Notice

All clients that want to join the same ODIN room, need to use a token generated from either the same access key or another access key of the same project.

While you can create an unlimited number of access keys for your projects, we strongly recommend that you never put an access key in your client code. Please refer to the Examples section to grab some code snippets to help you generate ODIN room rokens in a secure way.

Generating Access Keys

Every access key is a 44 character long Base64-String, which consists of an internal version mumber, a set of random bytes and a checksum. We’re providing several methods for generating new access keys using our SDKs.

You can create an access key for up to 25 concurrent users for free directly in the widget below.

Using the SDK

We’re providing several ways to create access keys locally using one of our SDKs. The resulting access keys can be used to access the ODIN network with up to 25 concurrently connected users free of charge.

Generate Access Key and retrieve its Key ID

C JavaScript

#include <stdio.h>

#include "odin.h"

int main()
{
  char access_key[128];
  char key_id[64];
  int error;

  error = odin_access_key_generate(access_key, sizeof(access_key));

  if (odin_is_error(error))
  {
    printf("Failed to generate access key; error %d\\n", error);
    return 1;
  }

  printf("Your new access key is: %s\\n", access_key);

  error = odin_access_key_id(access_key, key_id, sizeof(key_id));

  if (odin_is_error(error))
  {
    printf("Failed to get key ID from access key; error %d\\n", error);
    return 1;
  }

  printf("The key ID for your access key is: %s\\n", key_id);

  return 0;
}

var odinTokens = require("@4players/odin-tokens")

var accessKey = odinTokens.generateAccessKey();

console.log("Your new access key is: " + accessKey);

var keyPair = odinTokens.loadAccessKey(accessKey);
var keyId = odinTokens.getKeyId(keyPair.publicKey);

console.log("The key ID for your access key is: " + keyId);

If you’ve an active ODIN subscription, contact us, to submit the public key for an existing access key.

With ODIN Command Line Utility

We provide an NPM based command line utility that you can use to generate an access key. Install it with this command:

> npm install -g @4players/odin-cli

Then, you can use the command line tool in your terminal to generate an access key:

> odin-cli create-access-key

You’ll get a response similar to this one. You can use the access key in all SDKs available.

Your access key:
AQMaxMG2nLNvdUCdHp+lZKfNYKuxs4Vb/O7kPI4rEeX2
Please note: This access key is only valid for up to 25 users and may not be used in production!
Sign up to generate access keys production and/or more users: https://app.tarif-config.4players.de/config/149/en_GB

Flowchart

The relationships between the individual components of an access key are as follows:

graph LR
  RandomBytes[Random Bytes] --> AccessKey;
  AccessKey[Access Key] --> PublicKey;
  AccessKey --> SecretKey[Secret Key];
  PublicKey[Public Key] --> KeyId[Key ID];

Terminology

Access Key: Gives access to the ODIN network. It is a 44 character long Base64-String, which consists of a version, random bytes and a checksum.
Secret Key: Generated from the access key, it is based on the Ed25519-Curve and used to sign a room generated by the game developer.
Public Key: Generated from the access key, it is based on the Ed25519-Curve and must be uploaded to 4Players so that a generated room token can be verified.
Key ID: A shortened public key, included in the token, making it possible to identify what public key must be used to verify the room token.
Room Token: A signed JWT given to the game clients that allows them to connect to a voice chat room in the ODIN network.

`}),e.add({id:3596,href:"https://www.4players.io/odin/sdk/c/",title:"C/C++",section:"ODIN Documentation",description:"Dive into the core client API of ODIN C/C++ SDK, providing the foundation for high-level SDKs like Unity and Unreal. Explore our public Github repository to access source code and experiment with the powerful CLI application for seamless integration in your projects.",content:`

This is the core client API implemented in Rust and exported to native C libraries. These libraries are the building blocks for our high level SDKs like Unity SDK or Unreal SDK.

Please check out our public Github repository for more information, source-code and a cool CLI application to play around with ODIN right from your command line.

Usage

Quick Start

The following code snippet illustrates how to join a designated room on a specified server using a room token acquired externally:

#include <stdio.h>
#include "odin.h"

int main(int argc, const char *argv[])
{
    odin_startup(ODIN_VERSION);

    OdinRoomHandle room = odin_room_create();
    odin_room_join(room, "<SERVER_URL>", "<TOKEN>");

    getchar();

    return 0;
}

Authentication

To enter a room, an authentication token is requisite. ODIN employs the creation of signed JSON Web Tokens (JWT) to ensure a secure authentication pathway. These tokens encapsulate the details of the room(s) you wish to join alongside a customizable identifier for the user, which can be leveraged to reference an existing record within your specific service.

char token[512];

OdinTokenGenerator *generator = odin_token_generator_create("<ACCESS_KEY>");

odin_token_generator_create_token_ex(generator, "<ROOM_ID>", "<USER_ID>", token, sizeof(token));

As ODIN is fully user agnostic, 4Players GmbH does not store any of this information on its servers.

Tokens are signed employing an Ed25519 key pair derived from your distinctive access key. Think of an access key as a singular, unique authentication credential, crucial for generating room tokens to access the ODIN server network. It essentially combines the roles of a username and password into a singular, unobtrusive string of characters, necessitating a comparable degree of protection. For bolstered security, it is strongly recommended to refrain from incorporating an access key in your client-side code. We’ve created a very basic Node.js server here, to showcase how to issue ODIN tokens to your client apps without exposing your access key.

Event Handling

The ODIN API operates on an event-driven paradigm. In order to manage events, it’s necessary to create a callback function in the following manner:

void handle_odin_event(OdinRoomHandle room, const OdinEvent *event, void *data)
{
   switch (event->tag)
   {
      case OdinEvent_RoomConnectionStateChanged:
         // Triggered when the room's connectivity state transitions
         break;
      case OdinEvent_Joined:
         // Triggered post successful room entry, rendering the initial state fully accessible
         break;
      case OdinEvent_RoomUserDataChanged:
         // Triggered when the room's arbitrary user data changed
         break;
      case OdinEvent_PeerJoined:
         // Triggered when a new user enters the room
         break;
      case OdinEvent_PeerLeft:
         // Triggered when a user exits the room
         break;
      case OdinEvent_PeerUserDataChanged:
         // Triggered when a peers's arbitrary user data changed
         break;
      case OdinEvent_MediaAdded:
         // Triggered when a peer introduces a media stream into the room
         break;
      case OdinEvent_MediaRemoved:
         // Triggered when a peer withdraws a media stream from the room
         break;
      case OdinEvent_MediaActiveStateChanged:
         // Triggered on change of media stream activity (e.g. user started/stopped talking)
         break;
      case OdinEvent_MessageReceived:
         // Triggered upon receipt of a message containing arbitrary data from a peer
         break;
      default:
         // Optionally handle unexpected events
         break;
    }
}

To register your callback function as an handler for ODIN events for a room, use the following command:

odin_room_set_event_callback(room, handle_odin_event, NULL);

Media Streams

Each peer within an ODIN room has the capability to attach media streams for the transmission of voice data. The snippet below illustrates the procedure to establish a new input media stream:

OdinAudioStreamConfig config = {
    .sample_rate = 48000,
    .channel_count = 1,
};

OdinMediaStreamHandle stream = odin_audio_stream_create(config);

odin_room_add_media(room, stream);

For the handling of audio data through input/output media streams, employ the odin_audio_push_data and odin_audio_read_data functions. These functions enable the conveyance of audio data from your local microphone to your audio engine, and the playback of audio data received from other peers, respectively. For a comprehensive working example, refer to our Console Client example, which employs the miniaudio library for cross-platform audio capture and playback.

Audio Processing

Each ODIN room handle is equipped with a dedicated Audio Processing Module (APM) responsible for executing a spectrum of audio filters including, but not limited to, echo cancellation, noise suppression, and sophisticated voice activity detection. This module is designed to accommodate on-the-fly adjustments, empowering you to fine-tune audio settings in real time to suit evolving conditions. The snippet below demonstrates how you might alter the APM settings:

OdinApmConfig apm_config = {
    .voice_activity_detection = true,
    .voice_activity_detection_attack_probability = 0.9,
    .voice_activity_detection_release_probability = 0.8,
    .volume_gate = false,
    .volume_gate_attack_loudness = -30,
    .volume_gate_release_loudness = -40,
    .echo_canceller = true,
    .high_pass_filter = false,
    .pre_amplifier = false,
    .noise_suppression_level = OdinNoiseSuppressionLevel_Moderate,
    .transient_suppressor = false,
    .gain_controller = true,
};

odin_room_configure_apm(room, apm_config);

The ODIN APM provides the following features:

Voice Activity Detection (VAD)

When enabled, ODIN will analyze the audio input signal using smart voice detection algorithm to determine the presence of speech. You can define both the probability required to start and stop transmitting.

Input Volume Gate

When enabled, the volume gate will measure the volume of the input audio signal, thus deciding when a user is speaking loud enough to transmit voice data. You can define both the root mean square power (dBFS) for when the gate should engage and disengage.

Acoustic Echo Cancellation (AEC)

When enabled the echo canceller will try to subtract echoes, reverberation, and unwanted added sounds from the audio input signal. Note, that you need to process the reverse audio stream, also known as the loopback data to be used in the ODIN echo canceller.

Noise Suppression

When enbabled, the noise suppressor will remove distracting background noise from the input audio signal. You can control the aggressiveness of the suppression. Increasing the level will reduce the noise level at the expense of a higher speech distortion.

High-Pass Filter (HPF)

When enabled, the high-pass filter will remove low-frequency content from the input audio signal, thus making it sound cleaner and more focused.

Preamplifier

When enabled, the preamplifier will boost the signal of sensitive microphones by taking really weak audio signals and making them louder.

Transient Suppression

When enabled, the transient suppressor will try to detect and attenuate keyboard clicks.

Automatic Gain Control (AGC)

When enabled, the gain controller will bring the input audio signal to an appropriate range when it’s either too loud or too quiet.

User Data

Each peer within a room is associated with a unique user data represented as a byte array (uint8_t *). This data is synchronized automatically across all peers, facilitating the storage of bespoke information for every individual peer. Peers have the autonomy to modify their respective user data at any juncture, inclusive of before room entry to set an initial user data value.

char *user_data = "{\\"foo\\":\\"bar\\"}";

odin_room_update_peer_user_data(room, (uint8_t *)user_data, strlen(user_data));

Messages

ODIN allows you to send arbitrary to every other peer in the room or even individual targets. Just like user data, a message is a byte array (uint8_t *).

Note: Messages are always sent to all targets in the room, even when they moved out of proximity using setPosition.

struct MyMessage msg = {
   .foo = 1,
   .bar = 2,
};

odin_room_send_message(room, NULL, 0, (uint8_t *)&msg, sizeof(msg));

C-API Header

/* Copyright (c) 4Players GmbH. All rights reserved. */

#pragma once

/** @file */

#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>

#define ODIN_VERSION "1.6.4"

/**
 * Known types of a media stream.
 *
 * Note: Video streams are not supported yet.
 */
typedef enum OdinMediaStreamType {
    /**
     * Media stream is of type audio
     */
    OdinMediaStreamType_Audio,
    /**
     * Media stream is of type video
     */
    OdinMediaStreamType_Video,
    /**
     * Media stream is invalid
     */
    OdinMediaStreamType_Invalid,
} OdinMediaStreamType;

/**
 * Valid levels for aggressiveness of the noise suppression. A higher level will reduce the noise
 * level at the expense of a higher speech distortion.
 */
typedef enum OdinNoiseSuppressionLevel {
    /**
     * Noise suppression is disabled
     */
    OdinNoiseSuppressionLevel_None,
    /**
     * Use low suppression (6 dB)
     */
    OdinNoiseSuppressionLevel_Low,
    /**
     * Use moderate suppression (12 dB)
     */
    OdinNoiseSuppressionLevel_Moderate,
    /**
     * Use high suppression (18 dB)
     */
    OdinNoiseSuppressionLevel_High,
    /**
     * Use very high suppression (21 dB)
     */
    OdinNoiseSuppressionLevel_VeryHigh,
} OdinNoiseSuppressionLevel;

/**
 * All valid connection states for an ODIN room.
 */
typedef enum OdinRoomConnectionState {
    /**
     * Connection is being established
     */
    OdinRoomConnectionState_Connecting,
    /**
     * Connection is established
     */
    OdinRoomConnectionState_Connected,
    /**
     * Connection is being closed
     */
    OdinRoomConnectionState_Disconnecting,
    /**
     * Connection is closed
     */
    OdinRoomConnectionState_Disconnected,
} OdinRoomConnectionState;

/**
 * Possible reasons for connection state changes of an ODIN room.
 */
typedef enum OdinRoomConnectionStateChangeReason {
    /**
     * Connection state change was initiated by the user
     */
    OdinRoomConnectionStateChangeReason_ClientRequested,
    /**
     * Connection state change was initiated by the server (e.g. peer was kicked)
     */
    OdinRoomConnectionStateChangeReason_ServerRequested,
    /**
     * Connection state change was caused by a timeout
     */
    OdinRoomConnectionStateChangeReason_ConnectionLost,
} OdinRoomConnectionStateChangeReason;

/**
 * Valid audiences for ODIN room tokens.
 */
typedef enum OdinTokenAudience {
    /**
     * JWT has no audience
     */
    OdinTokenAudience_None,
    /**
     * JWT is accepted the ODIN gateway
     */
    OdinTokenAudience_Gateway,
    /**
     * JWT is accepted by the ODIN server
     */
    OdinTokenAudience_Sfu,
} OdinTokenAudience;

/**
 * A pointer to a local ODIN token generator, employed for generating signed room tokens predicated
 * on an access key. Be aware that access keys serve as your unique authentication keys, requisite
 * for generating room tokens to access the ODIN server network. To ensure your security, it's
 * strongly recommended that you _NEVER_ embed an access key within your client code, and instead
 * generate room tokens on a server.
 */
typedef struct OdinTokenGenerator OdinTokenGenerator;

/**
 * A numeric code returned by ODIN function calls. Use \`odin_is_error\` to determine whether the
 * code represents an error or an actual result value.
 *
 * Note: Use \`odin_error_format\` to get a human readable string to represent error codes.
 */
typedef uint32_t OdinReturnCode;

/**
 * Audio stream configuration.
 */
typedef struct OdinAudioStreamConfig {
    /**
     * The number of samples per second in hertz (between 8000 and 192000)
     */
    uint32_t sample_rate;
    /**
     * The number of channels for the new audio stream (between 1 and 2)
     */
    uint8_t channel_count;
} OdinAudioStreamConfig;

/**
 * Internal handle identifier for an ODIN room to interact with.
 */
typedef size_t OdinRoomHandle;

/**
 * Internal handle identifier for an ODIN audio/video stream used to send/receive data.
 */
typedef size_t OdinMediaStreamHandle;

/**
 * All the different events emitted from an ODIN room.
 */
typedef enum OdinEventTag {
    /**
     * Emitted after joining once initial room information was processed
     */
    OdinEvent_Joined,
    /**
     * Emitted when other peers joined the room
     */
    OdinEvent_PeerJoined,
    /**
     * Emitted when other peers left the room
     */
    OdinEvent_PeerLeft,
    /**
     * Emitted when other peers updated their user data
     */
    OdinEvent_PeerUserDataChanged,
    /**
     * Emitted when other peers started a media stream
     */
    OdinEvent_MediaAdded,
    /**
     * Emitted when other peers stopped a media stream
     */
    OdinEvent_MediaRemoved,
    /**
     * Emitted whenever data is sent/received over any known media
     */
    OdinEvent_MediaActiveStateChanged,
    /**
     * Emitted when other peers changed the global user data of the room itself
     */
    OdinEvent_RoomUserDataChanged,
    /**
     * Emitted when the internal room connection state of the ODIN client changed
     */
    OdinEvent_RoomConnectionStateChanged,
    /**
     * Emitted when others peers sent arbitrary data
     */
    OdinEvent_MessageReceived,
} OdinEventTag;

typedef struct OdinEvent_JoinedData {
    /**
     * Name of the joined room (null-terminated)
     */
    const char *room_id;
    /**
     * Length of the room name
     */
    size_t room_id_len;
    /**
     * Byte array with arbitrary user data of the room
     */
    const uint8_t *room_user_data;
    /**
     * Length of the room user data array
     */
    size_t room_user_data_len;
    /**
     * Identifier of the customer the room is assigned to (nul-terminated)
     */
    const char *customer;
    /**
     * Length of the customer identifier
     */
    size_t customer_len;
    /**
     * Own peer ID assigned by the server
     */
    uint64_t own_peer_id;
    /**
     * Own user identifier of the peer specified during authentication (null-terminated)
     */
    const char *own_user_id;
    /**
     * Length of the own user identifier
     */
    size_t own_user_id_len;
} OdinEvent_JoinedData;

typedef struct OdinEvent_PeerJoinedData {
    /**
     * ID of the peer
     */
    uint64_t peer_id;
    /**
     * Byte array with arbitrary user data of the peer
     */
    const uint8_t *peer_user_data;
    /**
     * Length of the room user data array
     */
    size_t peer_user_data_len;
    /**
     * User identifier of the peer specified during authentication (null-terminated)
     */
    const char *user_id;
    /**
     * Length of the user identifier
     */
    size_t user_id_len;
} OdinEvent_PeerJoinedData;

typedef struct OdinEvent_PeerLeftData {
    /**
     * ID of the peer
     */
    uint64_t peer_id;
} OdinEvent_PeerLeftData;

typedef struct OdinEvent_PeerUserDataChangedData {
    /**
     * ID of the peer
     */
    uint64_t peer_id;
    /**
     * Byte array with arbitrary user data of the peer
     */
    const uint8_t *peer_user_data;
    /**
     * Length of the room user data array
     */
    size_t peer_user_data_len;
} OdinEvent_PeerUserDataChangedData;

typedef struct OdinEvent_MediaAddedData {
    /**
     * ID of the peer this media belongs to
     */
    uint64_t peer_id;
    /**
     * Handle identifier of the new audio/video stream
     */
    OdinMediaStreamHandle media_handle;
} OdinEvent_MediaAddedData;

typedef struct OdinEvent_MediaRemovedData {
    /**
     * ID of the peer this media belongs to
     */
    uint64_t peer_id;
    /**
     * Handle identifier of the audio/video stream
     */
    OdinMediaStreamHandle media_handle;
} OdinEvent_MediaRemovedData;

typedef struct OdinEvent_MediaActiveStateChangedData {
    /**
     * ID of the peer this media belongs to
     */
    uint64_t peer_id;
    /**
     * Handle identifier of the audio/video stream
     */
    OdinMediaStreamHandle media_handle;
    /**
     * Indicator for whether or not the media is sending/receiving data
     */
    bool active;
} OdinEvent_MediaActiveStateChangedData;

typedef struct OdinEvent_RoomUserDataChangedData {
    /**
     * Byte array with arbitrary user data of the room
     */
    const uint8_t *room_user_data;
    /**
     * Length of the room user data array
     */
    size_t room_user_data_len;
} OdinEvent_RoomUserDataChangedData;

typedef struct OdinEvent_RoomConnectionStateChangedData {
    /**
     * Status of the room connection
     */
    enum OdinRoomConnectionState state;
    /**
     * Reason for this update
     */
    enum OdinRoomConnectionStateChangeReason reason;
} OdinEvent_RoomConnectionStateChangedData;

typedef struct OdinEvent_MessageReceivedData {
    /**
     * ID of the peer who sent this message
     */
    uint64_t peer_id;
    /**
     * Byte array with arbitrary data received
     */
    const uint8_t *data;
    /**
     * Length of the data array
     */
    size_t data_len;
} OdinEvent_MessageReceivedData;

typedef struct OdinEvent {
    OdinEventTag tag;
    union {
        OdinEvent_JoinedData joined;
        OdinEvent_PeerJoinedData peer_joined;
        OdinEvent_PeerLeftData peer_left;
        OdinEvent_PeerUserDataChangedData peer_user_data_changed;
        OdinEvent_MediaAddedData media_added;
        OdinEvent_MediaRemovedData media_removed;
        OdinEvent_MediaActiveStateChangedData media_active_state_changed;
        OdinEvent_RoomUserDataChangedData room_user_data_changed;
        OdinEvent_RoomConnectionStateChangedData room_connection_state_changed;
        OdinEvent_MessageReceivedData message_received;
    };
} OdinEvent;

/**
 * Statistics for the underlying connection of a room.
 */
typedef struct OdinConnectionStats {
    /**
     * The amount of outgoing UDP datagrams observed
     */
    uint64_t udp_tx_datagrams;
    /**
     * The amount of outgoing acknowledgement frames observed
     */
    uint64_t udp_tx_acks;
    /**
     * The total amount of bytes which have been transferred inside outgoing UDP datagrams
     */
    uint64_t udp_tx_bytes;
    /**
     * The amount of incoming UDP datagrams observed
     */
    uint64_t udp_rx_datagrams;
    /**
     * The amount of incoming acknowledgement frames observed
     */
    uint64_t udp_rx_acks;
    /**
     * The total amount of bytes which have been transferred inside incoming UDP datagrams
     */
    uint64_t udp_rx_bytes;
    /**
     * Current congestion window of the connection
     */
    uint64_t cwnd;
    /**
     * Congestion events on the connection
     */
    uint64_t congestion_events;
    /**
     * Current best estimate of the connection latency (round-trip-time) in milliseconds
     */
    float rtt;
} OdinConnectionStats;

/**
 * Per-room configuration of the ODIN audio processing module which provides a variety of smart
 * enhancement algorithms.
 */
typedef struct OdinApmConfig {
    /**
     * Enables or disables voice activity detection (VAD)
     */
    bool voice_activity_detection;
    /**
     * Voice probability value when the VAD should engage
     */
    float voice_activity_detection_attack_probability;
    /**
     * Voice probability value when the VAD should disengage
     */
    float voice_activity_detection_release_probability;
    /**
     * Enables or disables the input volume gate
     */
    bool volume_gate;
    /**
     * Root mean square power (dBFS) when the volume gate should engage
     */
    float volume_gate_attack_loudness;
    /**
     * Root mean square power (dBFS) when the volume gate should disengage
     */
    float volume_gate_release_loudness;
    /**
     * Enable or disable echo cancellation
     */
    bool echo_canceller;
    /**
     * Enable or disable high pass filtering
     */
    bool high_pass_filter;
    /**
     * Enable or disable the pre amplifier
     */
    bool pre_amplifier;
    /**
     * Set the aggressiveness of the suppression
     */
    enum OdinNoiseSuppressionLevel noise_suppression_level;
    /**
     * Enable or disable the transient suppressor
     */
    bool transient_suppressor;
    /**
     * Enable or disable the gain controller
     */
    bool gain_controller;
} OdinApmConfig;

/**
 * Audio stream statistics.
 */
typedef struct OdinAudioStreamStats {
    /**
     * The total number of packets seen by the medias jitter buffer.
     */
    uint32_t packets_total;
    /**
     * The number of packets processed by the medias jitter buffer.
     */
    uint32_t packets_processed;
    /**
     * The number of packets dropped because they seemed to arrive too early.
     */
    uint32_t packets_arrived_too_early;
    /**
     * The number of packets dropped because they seemed to arrive too late.
     */
    uint32_t packets_arrived_too_late;
    /**
     * The number of packets dropped due to a jitter buffer reset.
     */
    uint32_t packets_dropped;
    /**
     * The number of packets marked as invalid.
     */
    uint32_t packets_invalid;
    /**
     * The number of packets marked as duplicates.
     */
    uint32_t packets_repeated;
    /**
     * The number of packets marked as lost during transmission.
     */
    uint32_t packets_lost;
} OdinAudioStreamStats;

typedef size_t OdinResamplerHandle;

/**
 * Options for ODIN room tokens.
 */
typedef struct OdinTokenOptions {
    /**
     * Customer identifier (you should _NOT_ set this unless connecting directly to an ODIN server)
     */
    const char *customer;
    /**
     * Audience of the token
     */
    enum OdinTokenAudience audience;
    /**
     * Token lifetime in seconds
     */
    uint64_t lifetime;
} OdinTokenOptions;

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

/**
 * Formats an ODIN return code into a human readable string representation for use in logging and
 * diagnostics. If \`buf\` is \`NULL\` this functions simply returns the required buffer length to
 * store the output buffer.
 */
size_t odin_error_format(OdinReturnCode error, char *buf, size_t buf_len);

/**
 * Checks whether the code returned from ODIN function calls represents an error or an actual
 * result. This is used to easier work with certain functions that might return an error or a
 * valid result like \`odin_audio_data_len\`.
 * Internally this simply does \`(code >> 29) > 0\`.
 */
bool odin_is_error(OdinReturnCode code);

/**
 * Initializes the internal ODIN client runtime with optimized settings for audio output, ensuring
 * the correct API header file is employed. This operation is ref-counted, necessitating paired
 * invocations of startup and shutdown within your application. The majority of the API functions
 * hinge on an active ODIN runtime, with the sole exception of \`access_key\` and \`token_generator\`
 * related functions.
 *
 * Note: Utilize \`ODIN_VERSION\` to supply the \`version\` argument.
 */
bool odin_startup(const char *version);

/**
 * Initializes the internal ODIN client runtime, permitting the specification of sample rate and
 * channel layout for audio output. This operation is ref-counted, necessitating paired invocations
 * of startup and shutdown within your application.
 *
 * Note: Ensure consistent settings are used on successive invocations of this function.
 */
bool odin_startup_ex(const char *version, struct OdinAudioStreamConfig output_config);

/**
 * Shuts down the internal ODIN runtime. It is advisable to invoke this function prior to
 * terminating the application. Post invocation, all \`odin_*\` methods will cease to function
 * immediately, provided the internal ref-count has descended to zero. Refer to \`odin_startup\`
 * for additional details.
 */
void odin_shutdown(void);

/**
 * Creates a new ODIN room handle in an unconnected state and returns its handle identifier. This
 * will return \`0\` when the internal ODIN client runtime is not initialized using \`odin_startup\`
 * or has already been terminated using \`odin_shutdown\`.
 */
OdinRoomHandle odin_room_create(void);

/**
 * Closes the specified ODIN room handle, thus making our own peer leave the room on the server
 * and closing the connection if needed.
 */
OdinReturnCode odin_room_close(OdinRoomHandle room);

/**
 * Destroys the specified ODIN room handle.
 */
OdinReturnCode odin_room_destroy(OdinRoomHandle room);

/**
 * Sets the event callback on the the specified \`OdinRoomHandle\`. Generally this should be called
 * _once_ before joining a room.
 */
OdinReturnCode odin_room_set_event_callback(OdinRoomHandle room,
                                            void (*callback)(OdinRoomHandle room,
                                                             const struct OdinEvent *event,
                                                             void *extra_data),
                                            void *extra_data);

/**
 * Sets the scaling factor for coordinates supplied to \`odin_room_update_position\`, facilitating
 * adaptation to your game's unique coordinate system requirements. Peers are visible to each other
 * only within a unit circle of radius \`1.0\`. When altering a peer's position, ensure the position
 * is scaled such that the maximum distance remains one or less. This scaling can be performed
 * manually or by specifying the multiplicative scale here.
 *
 * Note: It's crucial to maintain consistent scaling across all client applications.
 */
OdinReturnCode odin_room_set_position_scale(OdinRoomHandle room, float scale);

/**
 * Joins a room on an ODIN server. This function takes an URL to an ODIN gateway and a signed room
 * token obtained externally that authorizes the client to establish the connection. Unless you're
 * hosting your own servers, always use gateway running at \`https://gateway.odin.4players.io\`.
 */
OdinReturnCode odin_room_join(OdinRoomHandle room, const char *url, const char *token);

/**
 * Retrieves the room ID (e.g. the name of the room) from the specified \`OdinRoomHandle\`.
 */
OdinReturnCode odin_room_id(OdinRoomHandle room, char *out_id, size_t out_id_len);

/**
 * Retrieves the identifier of the customer the room is assigned to from the specified \`OdinRoomHandle\`.
 */
OdinReturnCode odin_room_customer(OdinRoomHandle room,
                                  char *out_customer,
                                  size_t out_customer_len);

/**
 * Retrieves your own peer ID from the specified \`OdinRoomHandle\`.
 */
OdinReturnCode odin_room_peer_id(OdinRoomHandle room, uint64_t *out_peer_id);

/**
 * Retrieves statistics for the underlying connection of the specified \`OdinRoomHandle\`.
 */
OdinReturnCode odin_room_connection_stats(OdinRoomHandle room, struct OdinConnectionStats *stats);

/**
 * Updates the custom user data for your own peer. All user data is synced automatically, which
 * allows storing of arbitrary information for each individual peer.
 *
 * Note: Use this before calling \`odin_room_join\` to set initial peer user data upon connect.
 */
OdinReturnCode odin_room_update_peer_user_data(OdinRoomHandle room,
                                               const uint8_t *user_data,
                                               size_t user_data_length);

/**
 * Updates the three-dimensional position of the current peer within the specified \`OdinRoomHandle\`.
 * The server utilizes the provided coordinates to perform automatic culling among peers in the same
 * room, based on unit circles with a radius of \`1.0\`. This feature is particularly beneficial in
 * scenarios involving a large number of peers within the same room, enabling peers to interact or
 * 'see' each other only when in close proximity. To modify the distance sensitivity for position
 * updates, use \`odin_room_set_position_scale\`.
 *
 * Note: Use this before calling \`odin_room_join\` to set the initial peer position upon connect.
 */
OdinReturnCode odin_room_update_position(OdinRoomHandle room, float x, float y, float z);

/**
 * Sends arbitrary data to a list of target peers over the ODIN server. If \`NULL\` is specified, the
 * message will be sent to all other peers in the same room.
 */
OdinReturnCode odin_room_send_message(OdinRoomHandle room,
                                      const uint64_t *peer_id_list,
                                      size_t peer_id_list_size,
                                      const uint8_t *data,
                                      size_t data_length);

/**
 * Adds a specified \`OdinMediaStreamHandle\` to the room. Please note, that this can only be done
 * _once_ on a given media. Trying to do it more than once will return an error on subsequent calls
 * to this function.
 */
OdinReturnCode odin_room_add_media(OdinRoomHandle room, OdinMediaStreamHandle media);

/**
 * Configures the ODIN audio processing module on the room with the specified config.
 */
OdinReturnCode odin_room_configure_apm(OdinRoomHandle room, struct OdinApmConfig config);

/**
 * Creates a new audio input stream, which can be added to a room and send data over it.
 */
OdinMediaStreamHandle odin_audio_stream_create(struct OdinAudioStreamConfig config);

/**
 * Creates a new video input stream, which can be added to a room and send data over it.
 *
 * Note: Video streams are not supported yet.
 */
OdinMediaStreamHandle odin_video_stream_create(void);

/**
 * Destroys the specified \`OdinMediaStreamHandle\`, after which you will no longer be able to
 * receive or send any data over it. If the media is currently 'attached' to a room it will be
 * removed.
 */
OdinReturnCode odin_media_stream_destroy(OdinMediaStreamHandle stream);

/**
 * Retrieves the media ID of the specified \`OdinMediaStreamHandle\`.
 */
OdinReturnCode odin_media_stream_media_id(OdinMediaStreamHandle stream, uint16_t *out_media_id);

/**
 * Retrieves the peer ID of the specified \`OdinMediaStreamHandle\`.
 */
OdinReturnCode odin_media_stream_peer_id(OdinMediaStreamHandle stream, uint64_t *out_peer_id);

/**
 * Returns the type of the specified media stream.
 *
 * Note: This function will always return \`OdinMediaStreamType_Audio\` at the moment.
 */
enum OdinMediaStreamType odin_media_stream_type(OdinMediaStreamHandle stream);

/**
 * Instructs the server to pause the specified \`OdinMediaStreamHandle\`, ceasing the reception of
 * data. This operation essentially communicates a server-side mute request from the client, thus
 * indicating a desire to halt packet reception for this media stream.
 */
OdinReturnCode odin_media_stream_pause(OdinMediaStreamHandle stream);

/**
 * Instructs the server to resume the specified output \`OdinMediaStreamHandle\`, re-initiating the
 * reception of data. This operation essentially communicates a server-side unmute request from the
 * client, indicating a desire to restart packet reception for this media stream.
 */
OdinReturnCode odin_media_stream_resume(OdinMediaStreamHandle stream);

/**
 * Sends data to the audio stream. The data has to be interleaved [-1, 1] float data.
 */
OdinReturnCode odin_audio_push_data(OdinMediaStreamHandle stream, const float *buf, size_t buf_len);

/**
 * Reads audio data from the specified \`OdinMediaStreamHandle\`. This will return audio data in the
 * format specified when calling \`odin_startup_ex\` or 48 kHz interleaved by default.
 */
OdinReturnCode odin_audio_read_data(OdinMediaStreamHandle stream,
                                    float *out_buffer,
                                    size_t out_buffer_len);

/**
 * Returns the number of samples available in the audio buffer of an output \`OdinMediaStreamHandle\`.
 */
OdinReturnCode odin_audio_data_len(OdinMediaStreamHandle stream);

/**
 * Resets the specified \`OdinMediaStreamHandle\` to its initial state, restoring 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.
 */
OdinReturnCode odin_audio_reset(OdinMediaStreamHandle stream);

/**
 * Retrieves statistics for the specified \`OdinMediaStreamHandle\`.
 *
 * Note: This will only work for output streams.
 */
OdinReturnCode odin_audio_stats(OdinMediaStreamHandle stream, struct OdinAudioStreamStats *stats);

/**
 * Reads up to \`out_buffer_len\` samples from the given streams and mixes them into the \`out_buffer\`.
 * All audio streams will be read based on the sample rate you chose when initializing the ODIN runtime
 * so make sure to allocate the buffer accordingly. After the call the \`out_buffer_len\` will contain
 * the amount of samples that have actually been read and mixed into \`out_buffer\`.
 *
 * If enabled this will also apply any audio processing to the output stream and feed back required
 * data to the internal audio processing pipeline which requires a final mix.
 */
OdinReturnCode odin_audio_mix_streams(OdinRoomHandle room,
                                      const OdinMediaStreamHandle *streams,
                                      size_t stream_count,
                                      float *out_buffer,
                                      size_t out_buffer_len);

/**
 * Processes the reverse audio stream, also known as the loopback data to be used in the ODIN echo
 * canceller. This should only be done if you are _NOT_ using \`odin_audio_mix_streams\`.
 */
OdinReturnCode odin_audio_process_reverse(OdinRoomHandle room, float *buffer, size_t buffer_len);

/**
 * Sets the delay estimate for the reverse stream used in the ODIN echo cancellation. This function
 * is important in scenarios where the audio output and the audio input are not synchronized. An
 * accurate delay value ensures that the echo canceller can correctly align the two audio streams,
 * resulting in effective echo cancellation.
 *
 * Improper delay values may lead to poor echo cancellation and thus degrade the quality of the
 * audio communication.
 */
OdinReturnCode odin_audio_set_stream_delay(OdinRoomHandle room, uint64_t delay_ms);

/**
 * Creates a new ODIN resampler instance. This is intended for situations where your audio pipeline
 * doesn't support 48 kHz.
 *
 * Note: One resampler should be used exclusively per audio stream.
 */
OdinResamplerHandle odin_resampler_create(uint32_t from_rate,
                                          uint32_t to_rate,
                                          uint16_t channel_count);

/**
 * Resamples a single chunk of audio. If the ODIN resampler instance was created with multiple
 * channels, the data is assumed to be interleaved. The \`output_capacity\` argument also serves as
 * an out parameter when the provided capacity wasn't enough to fulfill the resample request, in
 * which case this function will write the minimum required buffer size into the given variable.
 * On success, the written size for the processed sample is returned in both, the return value
 * and the \`output_capacity\` out parameter.
 */
OdinReturnCode odin_resampler_process(OdinResamplerHandle resampler,
                                      const float *input,
                                      size_t input_len,
                                      float *output,
                                      size_t *output_capacity);

/**
 * Destroys the given ODIN resampler instance. After this call, all attempts to use this handle
 * will fail.
 */
OdinReturnCode odin_resampler_destroy(OdinResamplerHandle resampler);

/**
 * Creates a new access key crucial for signing tokens, facilitating access to an ODIN server. An
 * access key is a 44-character long Base64 String, embodying a version identifier, random bytes,
 * and a checksum.
 */
OdinReturnCode odin_access_key_generate(char *buf, size_t buf_len);

/**
 * Extracts the key ID from a specified access key. The key ID is embedded in room tokens, enabling
 * the identification of the corresponding public key required for verification.
 */
OdinReturnCode odin_access_key_id(const char *access_key, char *out_key_id, size_t out_key_id_len);

/**
 * Extracts the public key from a specified access key. The public key, derived from the Ed25519
 * curve, must be shared with _4Players_ to enable verification of a generated room token.
 */
OdinReturnCode odin_access_key_public_key(const char *access_key,
                                          char *out_public_key,
                                          size_t out_public_key_len);

/**
 * Extracts the private key from a specified access key. The private key, rooted in the Ed25519
 * curve, is utilized to sign a generated room token for accessing the ODIN network.
 */
OdinReturnCode odin_access_key_secret_key(const char *access_key,
                                          char *out_secret_key,
                                          size_t out_secret_key_len);

/**
 * Creates a new token generator instance.
 */
struct OdinTokenGenerator *odin_token_generator_create(const char *access_key);

/**
 * Destroys an existing token generator instance.
 */
void odin_token_generator_destroy(struct OdinTokenGenerator *generator);

/**
 * Generates a signed JWT, which can be used by an ODIN client to join a room.
 */
OdinReturnCode odin_token_generator_create_token(struct OdinTokenGenerator *generator,
                                                 const char *room_id,
                                                 const char *user_id,
                                                 char *out_token,
                                                 size_t out_token_len);

/**
 * Generates a signed JWT such as \`odin_token_generator_create_token\` and allows passing a custom
 * set of \`OdinTokenOptions\` for advanced use-cases.
 */
OdinReturnCode odin_token_generator_create_token_ex(struct OdinTokenGenerator *generator,
                                                    const char *room_id,
                                                    const char *user_id,
                                                    const struct OdinTokenOptions *options,
                                                    char *out_token,
                                                    size_t out_token_len);

#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus

`}),e.add({id:3597,href:"https://www.4players.io/odin/sdk/unity/1.1.0/manual/",title:"Manual",section:"ODIN Documentation",description:"Manual for Unity Components and ODIN integration in Unity Editor",content:`

The ODIN Unity SDK provides some prefabs and components that allow you to quickly embed true 3D positional real-time audio into your game with ease.

We also provide sample code within the SDK and some Github repositories.

Setup

After installing the SDK you need to setup a couple of ODIN components in your scene.

Tip

ODIN uses a singleton to manage lifetime of ODIN your game. Odin Handler uses DontDestroyOnLoad to survive scene changes. Best place to put the Odin Handler is in one of your starting game scenes like “Loading” or “Main Menu”.

Using Prefabs

In Packages/4Players ODIN/Runtime you find the OdinManager prefab. Drag & Drop that into your scene.

We also provide a couple of prefab variants, depending on your use-case. After installing the Unity SDK package you should also install the samples.

You’ll find the samples in the /Samples/4Players ODIN/__VERSION__/Examples folder in your Assets. We have created a couple of Odin Manager prefabs for different use-cases like 3D Audio. Drag them into your scene.

Create ODIN Manager manually

If you do not want to use our prefabs, you can also create an Odin Manager yourself. Follow these steps:

Create an empty Game Object
Optional: Add the Odin Banner component which will show a nice banner in your editor window that allows you to easily identify the ODIN Manager if you have a larger scene. And more importantly it looks cool ;-).
Add the Odin Editor Config component to the game object.
Add the Odin Handler component to the game object.
Add the Microphone Reader component to the game object.

The ODIN Manager

After you have dropped one of our prefabs into your scene or created the ODIN Manager Game Object yourself, you should see this in the Unity Inspector:

The ODIN Manager should be used for setting up ODIN in your game (i.e. sample rates or which microphone should be used) and it will also handle all the heavy lifting:

Generating access tokens so that players can connect to our ODIN servers
Managing ODIN events and exposing them in your project
Initialization of audio pipelines
Capture audio input from microphones and pushing audio data to ODIN runtime

The ODIN Manager typically consists of three parts:

The Odin Editor Config component for basic ODIN settings
The Odin Handler component that does event handling and allows you to connect callbacks
The Microphone Reader component that captures audio input

It’s not required to put all these components into one component, for example you can put the Microphone Reader component on another game object if you like but it’s typically easier if everything is in one place.

Let’s start digging through the inspector properties available in the Odin Editor Config .

`}),e.add({id:3598,href:"https://www.4players.io/odin/sdk/unity/1.6.6/manual/",title:"Manual",section:"ODIN Documentation",description:"Manual for Unity Components and ODIN integration in Unity Editor",content:`

The ODIN Unity SDK provides some prefabs and components that allow you to quickly embed true 3D positional real-time audio into your game with ease.

We also provide sample code within the SDK and some Github repositories.

Requirements

Supported platforms

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Setup

After installing the SDK you need to setup a couple of ODIN components in your scene.

Tip

Using Prefabs

In Packages/4Players ODIN/Runtime you find the OdinManager prefab. Drag & Drop that into your scene.

We also provide a couple of prefab variants, depending on your use-case. After installing the Unity SDK package you should also install the samples.

Create ODIN Manager manually

If you do not want to use our prefabs, you can also create an Odin Manager yourself. Follow these steps:

Create an empty Game Object
Optional: Add the Odin Banner component which will show a nice banner in your editor window that allows you to easily identify the ODIN Manager if you have a larger scene. And more importantly it looks cool ;-).
Add the Odin Editor Config component to the game object.
Add the Odin Handler component to the game object.
Add the Microphone Reader component to the game object.

The ODIN Manager

After you have dropped one of our prefabs into your scene or created the ODIN Manager Game Object yourself, you should see this in the Unity Inspector:

The ODIN Manager should be used for setting up ODIN in your game (i.e. sample rates or which microphone should be used) and it will also handle all the heavy lifting:

Generating access tokens so that players can connect to our ODIN servers
Managing ODIN events and exposing them in your project
Initialization of audio pipelines
Capture audio input from microphones and pushing audio data to ODIN runtime

The ODIN Manager typically consists of three parts:

The Odin Editor Config component for basic ODIN settings
The Odin Handler component that does event handling and allows you to connect callbacks
The Microphone Reader component that captures audio input

Let’s start digging through the inspector properties available in the Odin Editor Config .

`}),e.add({id:3599,href:"https://www.4players.io/odin/sdk/unity/2.0.0/manual/",title:"Manual",section:"ODIN Documentation",description:"Manual for Unity Components and ODIN integration in Unity Editor",content:`

The ODIN Unity SDK provides prefabs and components that allow you to quickly embed true 3D positional real-time audio into your game with ease. It also supports 2D non-spatial voice chat like in phone calls or radio communication.

Warning

Important Notice: Please be aware that our SDK version 2.0.0 is currently in a pre-release testing phase. It has not been officially released yet. We are rigorously testing it both internally and with a select group of external customers to ensure its quality and reliability. As a result, please note that the documentation for this version is still under development and may not be comprehensive. Information and features in the SDK are subject to change. We appreciate your understanding and patience during this testing period and welcome any feedback to help us improve. Thank you for your support! You’ll find the latest stable version of our SDK here.

Comparison to Previous Versions

When developing version 2 of our SDK we have made a lot of changes to the API and the way you interact with ODIN as we got a lot of feedback from our customers and we also learned a lot from our own experiences. Version 1.x made it super easy to quickly implement voice-chat into your game, but it was not very flexible and it was hard to customize the experience, especially when it comes to using more than one room or using 3D audio in use-cases that we have not thought of.

In version 1.x the central entry point has been the OdinHandler component which was a singleton and was responsible for everything. It was easy to use, but it was also hard to customize and it was not very flexible. If you wanted to customize the experience you had to create your own handler and copying a lot of code from our handler. This was not very user-friendly and it required a lot of knowledge about the internals of ODIN.

Getting started

In version 2.x you have the choice:

Using the OdinRoom component which does most of the heavy lifting for you and is very easy to use. It’s basically what OdinHandler has been before but it’s not a singleton anymore and you can create as many rooms as you want.
You can also dig deep into ODIN using the Room object manually in code and create your own experience from scratch. This is very powerful and gives you a lot of flexibility but is also more complex. As OdinRoom is built on top of Room you can also mix both approaches.

Understanding spatial and non-spatial voice-chat

In ODIN we differentiate between 2D non-spatial voice-chat and 3D spatial voice-chat. 2D non-spatial voice-chat is like in phone calls or radio communication where everyone hears everyone with the same volume. 3D spatial voice-chat is like in real-life where everyone hears everyone with different volumes and direction depending on their position in the room.

The main difference between 2D and 3D is how you handle events and how you position the audio in your game. In 2D you can just put the audio source where you want it and it will be heard by everyone and only requires that spatialBlend is set to 0.0 (2D sound).

In 3D, you need to attach the audio source representing the microphone of the “remote player” (i.e. a player connected to the same room) to the position of the remote player in your game (i.e. its avatar). This is usually done by finding the correct avatar game object and attaching the audio source to it. You also need to set the spatialBlend to 1.0 (3D sound).

To do that, you listen on the OdinRoom.OnPeerJoined event and OdinRoom.OnMediaAdded event to get the audio source of the remote player and attach it to the correct position in your game. In the low-level API it’s Room.OnPeerJoined and Room.OnMediaStarted . The main difference is that OdinRoom already handles these events for you (at least for 2D non-spacial voice-chat).

Deciding which approach to use

We try to give a quick and simple flow-chart to help you decide which approach to use:

graph TD
    B{What type of\\n Voice-Chat?}
    B -->|2D Voice-Chat| C[Use OdinRoom with\\n provided prefab]
    B -->|3D Voice-Chat| D{Multiple Rooms and\\n Connection Sharing?}
    D -->|No| E[Use OdinRoom with\\n custom event handling]
    D -->|Yes| F[Use Room]

We have compiled manuals on these different approaches, please choose one to continue/getting started:

`}),e.add({id:3600,href:"https://www.4players.io/odin/sdk/unity/manual/",title:"Manual",section:"ODIN Documentation",description:"Manual for Unity Components and ODIN integration in Unity Editor",content:`

The ODIN Unity SDK provides some prefabs and components that allow you to quickly embed true 3D positional real-time audio into your game with ease.

We also provide sample code within the SDK and some Github repositories.

Requirements

Supported platforms

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Setup

After installing the SDK you need to setup a couple of ODIN components in your scene.

Tip

Using Prefabs

In Packages/4Players ODIN/Runtime you find the OdinManager prefab. Drag & Drop that into your scene.

We also provide a couple of prefab variants, depending on your use-case. After installing the Unity SDK package you should also install the samples.

Create ODIN Manager manually

If you do not want to use our prefabs, you can also create an Odin Manager yourself. Follow these steps:

Create an empty Game Object
Optional: Add the Odin Banner component which will show a nice banner in your editor window that allows you to easily identify the ODIN Manager if you have a larger scene. And more importantly it looks cool ;-).
Add the Odin Editor Config component to the game object.
Add the Odin Handler component to the game object.
Add the Microphone Reader component to the game object.

The ODIN Manager

After you have dropped one of our prefabs into your scene or created the ODIN Manager Game Object yourself, you should see this in the Unity Inspector:

The ODIN Manager should be used for setting up ODIN in your game (i.e. sample rates or which microphone should be used) and it will also handle all the heavy lifting:

Generating access tokens so that players can connect to our ODIN servers
Managing ODIN events and exposing them in your project
Initialization of audio pipelines
Capture audio input from microphones and pushing audio data to ODIN runtime

The ODIN Manager typically consists of three parts:

The Odin Editor Config component for basic ODIN settings
The Odin Handler component that does event handling and allows you to connect callbacks
The Microphone Reader component that captures audio input

Let’s start digging through the inspector properties available in the Odin Editor Config .

`}),e.add({id:3601,href:"https://www.4players.io/odin/sdk/unity/",title:"Unity SDK",section:"ODIN Documentation",description:"Enhance your game or XR experience with 4Players ODIN, an easy-to-use Unity SDK for immersive 3D voice chat. Quickly integrate our solution with drag & drop functionality, and start customizing for your unique needs today! Supports Unity 2019.4+.",content:`

4Players ODIN

Our Unity SDK offers a quick “go to market” solution for immersive 3D voice chat that you can just “drag & drop” into your game or XR experience. ODIN is deeply integrated into Unity and handles all communication with servers and provides easy to use delegates and events that allows you to customize the experience very easily to your own needs.

⚠️

4Players ODIN supports Unity 2019.4 or any later version.

Source Code

You can find the full source code to our Unity SDK in our public GitHub repository:

If you encounter any bugs or issues, please let us know in the GitHub Issues area or refer to the Support page to contact us directly.

Getting Started

If you want to learn more about 4Players ODIN and how it fits into your game or XR experience then follow the Introduction. We have compiled a couple of use-cases for different types of games that should get you started quickly.

Follow our Getting Started guide and implement ODIN into an empty project in less than 20 minutes and learn about the basic concepts. Implementing ODIN into your multiplayer project is very easy too. Check out our Multiplayer Guide that will guide you step by step building a very easy multiplayer game from scratch with 3D voice chat support in under an hour.

Installing the SDK

Please follow these steps to install our SDK into your Unity project:

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Importing Samples

We ship a set of samples with the Unity SDK. To Import them into your project, open the Package Manager and hit import on the example you want to try.

Minimal Example: A very basic client for custom scripting to interact with 4Players ODIN.
Simple Room Join Example: A very basic client to automatically join a specified room for testing.
Push-to-Talk Example: Provides the same functionality as the simple room join, but with PTT support.
Audio 3D Example: Showcase for OdinClient Unity AudioSource handing with positional audio.

Manual

Implementing ODIN into your game only requires you to add and configure 3 components. We have created a manual to show you how to use them and which settings are available and how to use them.

Unity SDK API Reference

Check out our API Reference guide with the classes you might work with while implementing ODIN into your Unity application. We have compiled many code snippets and examples to get you started quickly. Head over to our API Reference to learn more about the features and possibilities the API has to offer.

`}),e.add({id:3602,href:"https://www.4players.io/odin/sdk/unity/1.1.0/",title:"Unity SDK v1.1.0",section:"ODIN Documentation",description:"Unity support for 4Players ODIN",content:`

4Players ODIN

⚠️

4Players ODIN supports Unity 2019.4 or any later version.

Source Code

You can find the full source code to our Unity SDK in our public GitHub repository:

If you encounter any bugs or issues, please let us know in the GitHub Issues area or refer to the Support page to contact us directly.

Getting Started

Installing the SDK

Please follow these steps to install our SDK into your Unity project:

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Importing Samples

We ship a set of samples with the Unity SDK. To Import them into your project, open the Package Manager and hit import on the example you want to try.

Minimal Example: A very basic client for custom scripting to interact with 4Players ODIN.
Simple Room Join Example: A very basic client to automatically join a specified room for testing.
Push-to-Talk Example: Provides the same functionality as the simple room join, but with PTT support.
Audio 3D Example: Showcase for OdinClient Unity AudioSource handing with positional audio.

Manual

Implementing ODIN into your game only requires you to add and configure 3 components. We have created a manual to show you how to use them and which settings are available and how to use them.

Unity SDK API Reference

`}),e.add({id:3603,href:"https://www.4players.io/odin/sdk/unity/1.5.8/",title:"Unity SDK v1.5.8",section:"ODIN Documentation",description:"ODIN Voice Chat SDK for Unity v1.5.8. Add 3D voice chat to your Unity game or XR experience in no-time.",content:`

4Players ODIN

⚠️

4Players ODIN supports Unity 2019.4 or any later version.

Source Code

You can find the full source code to our Unity SDK in our public GitHub repository:

If you encounter any bugs or issues, please let us know in the GitHub Issues area or refer to the Support page to contact us directly.

Getting Started

Installing the SDK

Please follow these steps to install our SDK into your Unity project:

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Importing Samples

We ship a set of samples with the Unity SDK. To Import them into your project, open the Package Manager and hit import on the example you want to try.

Minimal Example: A very basic client for custom scripting to interact with 4Players ODIN.
Simple Room Join Example: A very basic client to automatically join a specified room for testing.
Push-to-Talk Example: Provides the same functionality as the simple room join, but with PTT support.
Audio 3D Example: Showcase for OdinClient Unity AudioSource handing with positional audio.

Manual

Implementing ODIN into your game only requires you to add and configure 3 components. We have created a manual to show you how to use them and which settings are available and how to use them.

Unity SDK API Reference

`}),e.add({id:3604,href:"https://www.4players.io/odin/sdk/unity/1.6.0/",title:"Unity SDK v1.6.0",section:"ODIN Documentation",description:"ODIN Voice Chat SDK for Unity v1.6.0. Add 3D voice chat to your Unity game or XR experience in no-time.",content:`

4Players ODIN

⚠️

4Players ODIN supports Unity 2019.4 or any later version.

Source Code

You can find the full source code to our Unity SDK in our public GitHub repository:

If you encounter any bugs or issues, please let us know in the GitHub Issues area or refer to the Support page to contact us directly.

Getting Started

Installing the SDK

Please follow these steps to install our SDK into your Unity project:

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Importing Samples

We ship a set of samples with the Unity SDK. To Import them into your project, open the Package Manager and hit import on the example you want to try.

Minimal Example: A very basic client for custom scripting to interact with 4Players ODIN.
Simple Room Join Example: A very basic client to automatically join a specified room for testing.
Push-to-Talk Example: Provides the same functionality as the simple room join, but with PTT support.
Audio 3D Example: Showcase for OdinClient Unity AudioSource handing with positional audio.

Manual

Implementing ODIN into your game only requires you to add and configure 3 components. We have created a manual to show you how to use them and which settings are available and how to use them.

Unity SDK API Reference

`}),e.add({id:3605,href:"https://www.4players.io/odin/sdk/unity/1.6.6/",title:"Unity SDK v1.6.6",section:"ODIN Documentation",description:"ODIN Voice Chat SDK for Unity v1.6.6. Add 3D voice chat to your Unity game or XR experience in no-time.",content:`

4Players ODIN

⚠️

4Players ODIN supports Unity 2019.4 or any later version.

Source Code

You can find the full source code to our Unity SDK in our public GitHub repository:

If you encounter any bugs or issues, please let us know in the GitHub Issues area or refer to the Support page to contact us directly.

Getting Started

Installing the SDK

Please follow these steps to install our SDK into your Unity project:

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Download Unreal Engine SDK Get from Fab (former Unreal Marketplace)

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

Importing Samples

We ship a set of samples with the Unity SDK. To Import them into your project, open the Package Manager and hit import on the example you want to try.

Minimal Example: A very basic client for custom scripting to interact with 4Players ODIN.
Simple Room Join Example: A very basic client to automatically join a specified room for testing.
Push-to-Talk Example: Provides the same functionality as the simple room join, but with PTT support.
Audio 3D Example: Showcase for OdinClient Unity AudioSource handing with positional audio.

Manual

Implementing ODIN into your game only requires you to add and configure 3 components. We have created a manual to show you how to use them and which settings are available and how to use them.

Unity SDK API Reference

`}),e.add({id:3607,href:"https://www.4players.io/odin/sdk/unreal/",title:"Unreal Engine Plugin",section:"ODIN Documentation",description:"Integrate immersive spatial 3D voice chat with 4Players ODIN SDK for Unreal Engine 4 and 5. Enjoy full blueprint support, easy installation, and a sample project for seamless integration into your UE4 and UE5 projects. Compatible with UE 4.26 and later versions.",content:`

4Players ODIN

The Unreal Engine plugin is based on our C/C++ SDK and provides full blueprint support for UE4 and UE5. The latest version can be checked out from our Github repository:

Sample project

We have compiled a sample project that you can use as a reference to understand how to wire up the blueprints. As a quick tip: Select and copy our blueprints and paste them in into your own project!

Download Unreal Sample Project

Prerequisites

Unreal Engine 4.26 or any later version (including 5.x)

Internally, the plugin is built and tested with Unreal Engine 4.27.

Installing the plugin

You can install the plugin manually by downloading the source code from our Github repository or you can download it through the Unreal Marketplace.

Manual installation

To check out the SDK and use it as a project plugin, clone the git repo into a working directory of your choice.

This repository uses LFS (large file storage) to manage pre-compiled binaries. Note that a standard clone of the repository might only retrieve the metadata about these files managed with LFS. In order to retrieve the actual data with LFS, please follow these steps:

Clone the repository:
git clone https://github.com/4Players/odin-sdk-unreal.git
Cache the actual LFS data on your local machine:
git lfs fetch
Replaces the metadata in the binary files with their actual contents:
git lfs checkout

Next, unzip the files into a new Odin sub-folder under your projects Plugins folder. It should end up looking like /MyProject/Plugins/Odin/.

If you’re new to plugins in UE4, you can find lots of information right here.

Warning

When the Odin plugin is installed directly into a Blueprint Only Unreal Engine project, you may encounter an error when trying to run packaged standalone builds. This issue occurs because Unreal Engine processes Blueprint Only projects differently, and fails to correctly package C++ plugins that are installed directly within the project.

To resolve the error, you can either install the Plugin in the Engine’s installation directory (i.e. by using the Unreal Marketplace version), or convert your Blueprint Only Project into a C++ project. If you need assistance performing this step, please take a look at our guidelines for addressing this issue.

Fab (Unreal Marketplace)

This is the most comfortable solution as you get notified of new versions and installation is as easy as clicking a button.

Get ODIN from Fab

Using the plugin

Please make sure to read the introduction to have a basic understanding of how the plugin works. We have compiled a couple of use-cases for different types of games that should get you started quickly.

Manual

Implementing ODIN into your game can be done quickly and easily. We have created a manual to show you how to use them and which settings are available and how to use them.

Blueprint Reference

We have an extensive blueprint reference of all our nodes and functions. Check it out here.

`}),e.add({id:3608,href:"https://www.4players.io/fleet/sdk/nodejs/",title:"NodeJS",section:"ODIN Fleet Documentation",description:"Integrate ODIN Fleet into your CI/CD workflows and automate game server deployment and management with our NodeJS SDK.",content:`

This is the Node.js SDK designed to interact with the Fleet REST API, enabling developers to manage game servers efficiently. This SDK leverages the robust and scalable solutions offered by ODIN Fleet, making it easier to deploy and manage game servers across a global network.

Features

Server Management: Create, configure, deploy, and autoscale game servers.
CI/CD Integration: Seamlessly integrate into CI/CD pipelines for automated server management.
Cross-Platform Support: Compatible with various game engines and platforms.
Real-Time Scaling: Dynamically adjust the number of servers based on demand.
User-Friendly Interface: Simple API, dashboard, and CLI for easy server management.
Security: Built-in DDoS protection and GDPR/DSGVO compliance.

Installation

Install the SDK using npm:

npm install @4players/fleet-nodejs

Usage

Initialization

First, import and initialize the FleetApiClient with your API key:

const FleetApiClient = require('@4players/fleet-nodejs');

const client = new FleetApiClient("__YOUR_ACCESS_TOKEN__");

In TypeScript, you can import the SDK as follows:

import { FleetApiClient } from '@4players/fleet-nodejs';
const client = new FleetApiClient("__YOUR_ACCESS_TOKEN__");

Dashboard

Using our dashboard is an easy way of managing your game servers and applications. It’s also a good way to see which items are created by the examples and how they are structured.

You’ll find the dashboard at https://console.4players.io. All you need is a 4Players account which you can also create on the dashboard.

Next Steps

The following examples demonstrate how to use the FleetApiClient SDK to manage game servers using the Fleet API.

Example: Deploying a Minecraft Server

Depending on your business model you typically have your own docker image or have server binaries in Steam, but in this case we’ll use an existing Minecraft Docker image to deploy a Minecraft server.

Although you can create an App via Script, it’s easier to understand and to follow if we create the app in the dashboard as we need an API key for the script to work, so let’s create an app in the dashboard.

Navigate to the dashboard and create a new app. You can name it whatever you want, but for this example we’ll name it Minecraft. Once you have created the App, you’ll be routed to the apps dashboard where the App-ID is displayed. You’ll need this ID for the script. Click on the Copy button to copy the App-ID to your clipboard.

Let’s start with the initial part of the script:

import { FleetApiClient } from '@4players/fleet-nodejs';

var appId = __YOUR_APP_ID__;

Next, click on “Settings” on the left sidebar and choose “API-Keys” from the list. You’ll see your personal Access Token. Click the copy icon again and paste it into the script.

import { FleetApiClient } from '@4players/fleet-nodejs';

// Setup the client
var appId = __YOUR_APP_ID__;
var accessToken = "__YOUR_ACCESS_TOKEN__";
var client = new FleetApiClient(accessToken);

// Select our app so we don't need to provide the app id for every request
client.selectAppId(appId);

Now we need to create an image. We’ll use the Minecraft image from the Docker Hub. You can find the image here.

const version = '2024.6.1';

// We need to load the available docker registries to get the id of the default (docker hub) docker registry
let dockerRegistry: DockerRegistry = await client.getDockerRegistries().then((registries) => {
  return registries.find((registry) => registry.type === 'default');
});

// Setup the payload for the binary
const payload = {
  name: 'Minecraft',
  version: version,
  type: BinaryType.DockerImage,
  os: OperatingSystem.Linux,
  appId: app.id,
  dockerImage: {
    imageName: \`itzg/minecraft-server:\${version}\`,
    registryId: dockerRegistry.id,
  },
};

// Create the binary structure within ODIN Fleet - this image will later be deployed
let binary = null;
try {
  binary = await client.createBinary(payload);  
} catch (error) {
  console.error('Error creating binary:', error);
  process.exit(0);
}

Next, we’ll need to create a server config. A server config is a blueprint for a server. It defines the image, required resources, persistence, and other settings. This is a bit more complex and it might be helpful to play around with the dashboard to understand the structure of the server config.

As with most docker images, they are configured via environment variables. Which environment variables are available is defined in the Dockerfile. In this case, we’ll set the EULA to true, the server name to “ODIN Fleet”, the MOTD to “Welcome to our ODIN Fleet Minecraft Server”, the max players to 10, and disable the snooper.

You’ll find more info in these variables here.

let config = null;
try {
  config = await client.createServerConfig({
    name: \`Minecraft Production \${version}\`,
    binaryId: binary.id,  // We'll use the binary we just created
      resources: {          // This defines resources, 1 shared CPU and 2 GB of memory are enough
        limits: {
          cpu: 1,
          memory: 2,
        },
        reservations: {
          cpu: 0,
          memory: 0,
        },
      },
      restartPolicy: {
        condition: RestartPolicyCondition.Any,
      },
      mounts: [
        {
          target: '/data',    // This is where the server stores its data and we want to make sure it's backuped
          readOnly: false,
        },
      ],
      ports: [                // We need to expose the game port and tell the system that it's a TCP port
        {
          name: 'gamePort',
          targetPort: 25565,
          protocols: [Protocol.Tcp],
          publishMode: PublishMode.Ingress,
        },
      ],
      env: [                  // These are the environment variables (EULA is required). You can play around with different values
        {
          key: 'EULA',
          type: EnvironmentVariableType.Static,
          value: 'true',
        },
        {
          key: 'SERVER_NAME',
          type: EnvironmentVariableType.Static,
          value: 'ODIN Fleet',
        },
        {
          key: 'MOTD',
          type: EnvironmentVariableType.Static,
          value: 'Welcome to our ODIN Fleet Minecraft Server',
        },
        {
          key: 'MAX_PLAYERS',
          type: EnvironmentVariableType.Static,
          value: '10',
        },
        {
          key: 'SNOOPER_ENABLED',
          type: EnvironmentVariableType.Static,
          value: 'false',
        },
      ],
    });
} catch (error) {
  console.error('Error creating server config:', error);
  process.exit(0);
}

Now we can deploy the server. We’ll deploy 1 server in this example. We’ll use the german region to deploy it.

// Find first location in Germany
const location = await client.getLocations().then(({data}) => {
  return data.find((location) => location.country === 'de');
});

if (!location) {
  throw new Error('Location not found');
  process.exit(0);
}

let deployment = null;
try {
  deployment = await client.createDeployment({
    name: 'Minecraft Production',
    serverConfigId: config.id,
    autoScalerEnabled: false,
    numInstances: 1,
    placement: {
      constraints: {
        country: location.country,
        city: location.city,
      },
    },
  });
} catch (error) {
  console.error('Error creating deployment:', error);
  process.exit(0);
}

That’s it. You should now have a Minecraft server running in the german region. You can now connect to it using the IP address of the server.

Make sure to delete the deployment and the server config if you don’t need them anymore. You can also delete the binary if you don’t need it anymore.

You’ll find a list of deployed servers in the dashboard under “Servers”.

Getting a servers IP and Port

When you create a server config you define which ports need to be routed to the internet. In the above server config we created a port definition named “Game Port” and defining a TCP port at 25565. Our system will find a free port on the maschine and will route that port to the internal port where the gameserver is listening. To find out which port is used you can get the server details:

const servers = await client.getServers();
for (let server of servers) {
  // The server.ports map contains all ports that are exposed to the internet named by the port definition name
  var gamePort = server.ports["Game Port"]?.publishedPort;
  var ip = server.addr;
  
  console.log(\`Server \${server.id} is available at \${ip}:\${gamePort}\`);
}

Development

We are using OpenAPI to document our APIs and use generators to automatically build client code. However, as these generators have their weaknesses, we create a custom wrapper around the generated code to make it more user-friendly. In this case it’s the FleetApiClient. You can update the internal code by running the following command:

npm run generate-api-from-backend

This will download the current API specs from the backend and generate the client code. Typically some minor changes or additions are then required to FleetApiClient.

Open-Source

This SDK is open-source and available on GitHub.

API Documentation

The full API documentation is available in the OpenAPI specs: Fleet API Documentation.

Support

For additional support, get in touch on our Discord server.

Book a meeting or join a live presentation to learn more about ODIN Fleet and how it can help manage your game servers efficiently.

License

The NodeJS SDK is MIT License.

`}),e.add({id:3609,href:"https://www.4players.io/odin/sdk/nodejs/",title:"NodeJS",section:"ODIN Documentation",description:"Revolutionize multiplayer gaming with ODIN NodeJS SDK, enabling AI-driven NPCs to create interactive and engaging environments. Leverage server-side data and audio for real-time voice and data sync, creating next-generation applications in immersive gaming experiences.",content:`

We offer ODIN, a high-quality cross-platform immersive voice SDK that includes state-of-the-art noise suppression technologies.

Our Web SDK includes fallback code for WebRTC and is compatible with most browsers. While it can also be used in NodeJS, it may not be as performant as our native NodeJS SDK, which is designed for advanced use cases and bots.

The NodeJS SDK is currently in beta. This means that die API is not final and may change from version to version, and it may not be ready for large scale production use. If you encounter any issues, please let us know on our Discord server.

Although we strive to keep the API as similar as possible between our SDKs, there are some differences. Since wrapping objects in JavaScript and TypeScript is easier than in C/C++, we only use objects where necessary in our native SDK. For instance, the WebSDK provides an OdinPeer object that encapsulates various methods and properties. However, for NodeJS use cases, you usually only need a peerId and mediaId, so we decided not to overcomplicate things. Of course, you can always create your own wrapper if needed.

Tip

The main difference between the two SDKs is that the NodeJS version allows you to access raw audio data from the ODIN server, which enables you to record or stream audio to the room. While the WebSDK has similar capabilities, it relies on Web Audio, which is not available in NodeJS. Rather than creating a complex polyfill, we found it easier and faster to wrap the ODIN native SDK into NodeJS bindings.

By providing two separate libraries, we can optimize each one for its respective platform and use cases.

ODIN is our cross-platform immersive voice SDK with best in class quality and noise suppression technologies.

Source Code

The NodeJS SDK is developed in C/C++ using Node API and is open source. Check out the source in our public NPM repository.

Installation

npm npm npm

Install the web SDK via npm in your project like this:

npm install --save @4players/odin-nodejs

Interoperability

The ODIN web SDK is fully compatible with our other client SDKs so you can easily communicate between your NodeJS script and other clients - even Unity or Unreal Engine clients.

However, it’s important to understand, that you cannot combine the WebSDK and the NodeJS SDK in the same NodeJS-project, i.e. you eiter have @4players/odin-nodejs or @4players/odin in your package.json file, but not both.

Platform support

As the ODIN NodeJS SDK is a native module, it requires native binaries to be built for your platform. We currently provide prebuilt binaries for these platforms:

Windows (x64)
macOS (x64 and ARM)
Linux (x64)

If you deploy your application to a different platform, npm install will try to build the library from source. This requires a working C/C++ compiler and the necessary build tools to be installed on your system. You can find more info on that topic in the node-gyp documentation.

Event Handling

The ODIN server will automatically notify you about relevant updates and the ODIN NodeJS SDK is using the JavaScript EventTarget API to dispatch custom events based on the OdinEvents interface. Use any of the provided the addEventListener methods to set up a function that will be called whenever the specified event is delivered to the target.

These events are available:

AudioDataReceived

ConnectionStateChanged

Joined

Left

MediaActivity

MediaAdded

MediaRemoved

MessageReceived

PeerJoined

PeerLeft

PeerUserDataChanged

RoomUserDataChanged

Use them like shown in this example:

Listening for events

// Create an odin client instance using our access key and create a room
const odinClient = new OdinClient();
const room = odinClient.createRoom("__YOUR_ACCESS_KEY__", roomName, userName);

// Listen on PeerJoined messages and print the user data of the joined peer
room.addEventListener('PeerJoined', (event) => {
    console.log("Received PeerJoined event", event);
    console.log(JSON.parse(new TextDecoder().decode(event.userData)));
});

// Listen on PeerLeft messages and print the user data of the left peer
room.addEventListener('PeerLeft', (event) => {
    console.log("Received PeerLeft event", event);
});

Using Media objects

ODIN works with the concept of media objects that are attached to a room. A media is either remote (i.e. connected to the mic of someone else device) or a local media, which is linked to your own microphone or other input device.

After joining a room, you can create a media (linked to your local input device) and add to the room. After joining a room, you are just a listener in the room, you don’t send anything to it (i.e. your are muted).

Receiving audio data

Once the script has joined a room it receives events that you add handlers for. If you want to get access to audio data, you’ll need to add an event handler for AudioDataReceived . The data property of the event contains the audio samples in 16-bit format or 32-bit floats (-1 to 1):

Receiving audio data

// Add an event filter for audio data received events
room.addEventListener('AudioDataReceived', (data) => {
    // Getting an array of the sample buffer - use for example to visualize audio
    let ui32 = new Float32Array(data.samples32.buffer);
    console.log(ui32);

    let ui16 = new Int16Array(data.samples16.buffer);
    console.log(ui16);
});

Sending audio data

If you want to your bot to send audio into the room (i.e. text to speech or music and other sounds, you need to attach a media to that room:

Creating a media object

// Send music to the room
const sendMusic = async (media) => {
    // Prepare our MP3 decoder and load the sample file
    const audioBuffer = await decode(fs.readFileSync('./santa.mp3'));

    // ODIN requires 20ms chunks of audio data (i.e. 50 times a second). We need to calculate the chunk length based on 
    // the sample rate of the file by dividing it by 50. If sample rate is 48kHz, we need to send 960 samples per chunk.
    const chunkLength = audioBuffer.sampleRate/50;

    // Create a stream that will match the settings of the file
    const audioBufferStream = new AudioBufferStream({
        channels: audioBuffer.numberOfChannels,
        sampleRate: audioBuffer.sampleRate,
        float: true,
        bitDepth: 32,
        chunkLength: chunkLength
    });

    // Create a queue to store the chunks of audio data
    const queue = [];

    // Whenever the stream has data, add it to the queue
    audioBufferStream.on('data', (data) => {
        const floats = new Float32Array(new Uint8Array(data).buffer);
        queue.push(floats);
    });

    // Start a timer to send audio data at regular intervals
    const interval = setInterval(() => {
        if (queue.length > 0) {
            const chunk = queue.shift();
            media.sendAudioData(chunk);
        } else {
            // If there's no more data to send, stop the timer
            clearInterval(interval);
            audioBufferStream.end();
            console.log("Audio finished");
        }
    }, 20);  // Send a chunk every 20ms

    audioBufferStream.write(audioBuffer);
}

// Create a media stream in the room - it will return an OdinMedia instance that we can use to send data to ODIN
const media = room.createAudioStream(48000, 2);

// Start the stream and send the music to ODIN
sendMusic(media).then(() => {
    console.log("Finished sending song");
});

Examples

We have prepared a couple of examples to get you started with the ODIN NodeJS SDK. You can find them in our SDK in the tests folder. After installing the NodeJS SDK check out this folder: node_modules/@4players/odin-nodejs/tests. You’ll find one example on how to record audio and sending them to OpenAIs whisper module for transcription and another sample that shows you how to send data into the channel. Examples are also provided for sending text messages when users join the room.

`}),e.add({id:3611,href:"https://www.4players.io/fleet/sdk/restapi/",title:"REST-API",section:"ODIN Fleet Documentation",description:"Learn more about our REST-API and how to interact with it",content:`

The ODIN Fleet REST-API allows you to interact with the ODIN Fleet platform programmatically. You can use the API to automate game server deployment and management, integrate ODIN Fleet into your CI/CD workflows, and more.

We have published the OpenAPI specification for the ODIN Fleet REST-API, which you can use to generate SDKs for various programming languages. We provide an SDK for Node.js, which you can use to interact with the ODIN Fleet REST-API.

Documentation

We offer a nice interface to learn more about data structures and available routes.

View Documentation

Authentication

In order to use the ODIN Fleet REST-API, you need to authenticate your requests. You can do this by providing an API key in the Authorization header of your HTTP requests.

Authorization: Bearer YOUR_ACCESS_TOKEN

Sign in to our dashboard.
Choose an app or create one
Go to the settings of the app
Click on the API-Key section
Copy the access token and use it in your requests

Open API Generator

We provide an OpenAPI specification file that you can use to generate an SDK for your preferred programming language. The generated SDK will allow you to interact with the ODIN Fleet REST-API programmatically.

However, there are a few caveats to keep in mind when generating an SDK from the OpenAPI specification file:

Bearer Authorization does not work (although it is defined in the OpenAPI specification file and the generator should implement it)
The generated SDK may not be easy to use as you may need to create request objects all the time (instead of just using function parameters)

It depends on the generator, but we experienced these issues with quite a lot of generated code.

To circumvent these issues, we provide an SDK for Node.js that is specifically designed to interact with the ODIN Fleet REST-API and will provide a C# SDK soon. We typically create one entry class that sets up the correct settings and wraps the API calls in a more user-friendly way.

Here is an example of the Node.js SDK that we provide (left out comments and docs to keep it short):

export class FleetApiClient {

  private _client: FleetApi;

  constructor(accessToken: string, protected configuration = DefaultConfig) {

    // This needs to be set as the OpenAPI Generator doesn't support the Authorization header
    var headers = {
      Authorization: \`Bearer \${accessToken}\`,
    }

    // Setup the configuration
    var configParams = {
      basePath: configuration.basePath,
      headers: {...configuration.headers, ...headers},
      fetchApi: configuration.fetchApi,
      middleware: configuration.middleware,
      username: configuration.username,
      password: configuration.password,
      apiKey: configuration.apiKey,
      accessToken: configuration.accessToken,
      credentials: configuration.credentials,
    } as ConfigurationParameters;

    var config = new Configuration(configParams);

    this._client = new FleetApi(config);
  }

  get client(): FleetApi {
    return this._client;
  }

  // Wrap functions of the underlying SDK but in a more friendly way

  async createApp(name: string): Promise<App> {
    return this.client.createApp({createAppRequest: {name}});
  }

  async getApps(): Promise<Array<App>> {
    return this.client.getApps();
  }
  
  //....
}

`}),e.add({id:3612,href:"https://www.4players.io/odin/sdk/swift/",title:"Swift",section:"ODIN Documentation",description:"Integrate 4Players ODIN's Swift SDK for real-time VoIP chat in your macOS and iOS apps and multiplayer games. Supporting iOS 9.0+/macOS 10.15+, Xcode 10.2+, and Swift 5.0+. Access open-source samples and comprehensive documentation for a seamless experience.",content:`

OdinKit is a Swift package providing an object-oriented wrapper for the ODIN native client library, which enables developers to integrate real-time VoIP chat technology into multiplayer games and apps on macOS and iOS.

Requirements

iOS 9.0+ / macOS 10.15+
Xcode 10.2+
Swift 5.0+

Source Code

The Swift SDK is based on our C Core API and is open source. Check out the source of this Swift wrapper in our public Github repository.

Sample

Check out our SwiftUI sample built with OdinKit. It’s open source and should get you started quickly: SwiftUI Sample at Github.

Documentation

We provide a doccarchive file that you can import into Xcode to get access to the documentation in Xcodes documentation browser. Just download the file and double click to install: OdinKit.doccarchive

Installation

The ODIN SDK is provided as written in Swift and bundled in an XC Framework. Follow these steps to add it to your application.

1. Download and extract

Download the Framework and extract the ZIP file somewhere on your hard drive.

Download Swift SDK

2. Add the package to your workspace

In XCode, choose Add Packages… in the File menu. A new window appears.

Click on Add Local and you’ll be able to choose a framework located on your disk. It’s a standard macOS file selection dialog. Navigate to the folder you extracted (i.e. OdinKit) and click on “Add Package”;

That’s it. In your project navigator in XCode you should see OdinKit show up under the Packages tree item.

3. Build settings

Finally, we need to link the OdinKit package. In XCode, in the project navigator, select your project file and choose the correct target. Navigate to the General tab and scroll down to Framework, Libraries and Embedded Content.

Choosing the OdinKit framework folder previously extracted

Click on the + icon and select the OdinKit framework in the list as shown in this image:

Playgrounds

We have included a couple of Playgrounds into the OdinKit framework to get started quickly:

In the project navigator, expand the OdinKit framework under packages, choose Playgrounds and then either iOS or macOS.

Check out the Playground Source here if you are interested: OdinKit macOS Playground at Github

Quick Start

The following code snippet will create a token for authentication, join a room called “Meeting Room” and add a media stream using your default audio input device:

import OdinKit

let room = OdinRoom()

do {
    let accessKey = try OdinAccessKey("<YOUR_ACCESS_KEY>")
    let authToken = try accessKey.generateToken(roomId: "Meeting Room")

    try room.join(token: authToken)
    try room.addMedia(type: OdinMediaStreamType_Audio)
} catch {
    print("Something went wrong, \\(error)")
}

Class Overview

OdinKit provides a set of classes to provide easy access to just everything you need including low-level access to C-API functions of the ODIN Core SDK.

OdinAccessKey

An access key is the unique authentication key to be used to generate room tokens for accessing the ODIN server network. You should think of it as your individual username and password combination all wrapped up into a single non-comprehendible string of characters, and treat it with the same respect. For your own security, we strongly recommend that you NEVER put an access key in your client-side code. We’ve created a very basic Node.js server here, to showcase how to issue ODIN tokens to your client apps without exposing your access key.

Note: Using the OdinAccessKey default initializer will always create a new access key.

// Create a new access key
let accessKey = OdinAccessKey()

// Print information about the access key
print("Public Key: \\(accessKey.publicKey)")
print("Secret Key: \\(accessKey.secretKey)")
print("Key ID:     \\(accessKey.id)")

OdinAccessKey Class Reference

OdinToken

ODIN generates signed JSON Web Tokens (JWT) for secure authentication, which contain the room(s) you want to join as well as a freely definable identifier for the user. The later can be used to refer to an existing record in your particular service.

As ODIN is fully user agnostic, 4Players GmbH does not store any of this information on its servers.

// Generate a token to authenticate with
let authToken = try accessKey.generateToken(roomId: "foo", userId: "bar")

OdinToken Class Reference

OdinRoom

In ODIN, users who want to communicate with each other need to join the same room. Optionally, you can specify an alternative gateway URL when initializing an OdinRoom instance.

You can choose between a managed cloud and a self-hosted solution. Let 4Players GmbH deal with the setup, administration and bandwidth costs or run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. Unless you’re hosting your own servers, you don’t need to set a gateway URL, which will make the ODIN client use the default gateway running in the European Union.

// Create a new room instance
let room = OdinRoom(gateway: "https://gateway.odin.4players.io")

// Join the room
let ownPeerId = try room.join(token: authToken)

// Print information about the room
print("ID:        \\(room.id)")
print("User Data: \\(room.userData)")

OdinRoom Class Reference

OdinPeer

Once a client joins a room, it will be treated as a peer. Every peer has its own user data, which is a byte array ([UInt8]). This data is synced automatically, which allows storing of arbitrary information for each individual peer and even globally for the room if needed.

Peers can update their own user data at any time, even before joining a room to specify the initial user data value.

// Print information for all peers in the room
for (peerId, peer) in room.peers {
    print("ID:        \\(peer.id)")
    print("User ID:   \\(peer.userId)")
    print("User Data: \\(peer.userData)")
    print("Is Self:   \\(peer == room.ownPeer)")
}

OdinPeer Class Reference

OdinMedia

Each peer in an ODIN room can attach media streams to transmit voice data. By default, ODIN will always assume that your input device is working with a sample rate of 48 kHz. If you need to change these settings, you can either specify a custom OdinAudioStreamConfig or attach the OdinMedia instances of your room to an existing AVAudioEngine instance of your app.

// Append a local audio stream to capture our microphone
let newMediaId = try room.addMedia(audioConfig: OdinAudioStreamConfig(
    sample_rate: 48000,
    channel_count: 1
))

OdinMedia Class Reference

Event Handling

The ODIN API is event driven. Using the OdinKit package, you have two ways of handing events emitted in an ODIN room:

a) Setting a Room Delegate

Every OdinRoom instance allows setting an optional delegate to handle events. The delegate must be an instance of a class implementing the OdinRoomDelegate protocol, which defines all the necessary event callbacks.

// Define a class handing events
class YourCustomDelegate: OdinRoomDelegate {
    // Callback for internal room connectivity state changes
    func onRoomConnectionStateChanged(room: OdinRoom, oldState: OdinRoomConnectionState, newState: OdinRoomConnectionState, reason: OdinRoomConnectionStateChangeReason) {
        print("Connection status changed from \\(oldState.rawValue) to \\(newState.rawValue)")
    }

    // Callback for when a room was joined and the initial state is fully available
    func onRoomJoined(room: OdinRoom) {
        print("Room joined successfully as peer \\(room.ownPeer.id)")
    }

    // Callback for room user data changes
    func onRoomUserDataChanged(room: OdinRoom) {
        print("Global room user data changed to: \\(room.userData)")
    }

    // Callback for peers joining the room
    func onPeerJoined(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) joined the room with ID '\\(peer.userId)'")
    }

    // Callback for peer user data changes
    func onPeerUserDataChanged(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) updated its user data to: \\(peer.userData)")
    }

    // Callback for peers leaving the room
    func onPeerLeft(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) left the room")
    }

    // Callback for medias being added to the room
    func onMediaAdded(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) added media \\(media.id) to the room")
    }

    // Callback for media activity state changes
    func onMediaActiveStateChanged(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) \\(media.activityStatus ? "started" : "stopped") talking on media \\(media.id)")
    }

    // Callback for medias being removed from the room
    func onMediaRemoved(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) removed media \\(media.id) from the room")
    }

    // Callback for incoming arbitrary data messages
    func onMessageReceived(room: OdinRoom, senderId: UInt64, data: [UInt8]) {
        print("Peer \\(senderId) sent a message with arbitrary data: \\(data)")
    }
}

// Create an instance of your delegate
let delegate = YourCustomDelegate()

// Add the delegate to the room
room.delegate = delegate

b) Using Published Properties

Every OdinRoom instance provides a set of observable properties using the @Published property wrapper. This allows you to easily monitor these variables as signals are emitted whenever their values were changed.

There are three distinct properties you can observe:

OdinRoom.connectionStatus
This is a tuple representing current connection status of the room including a reason identifier for the last update.
OdinRoom.peers
This is a dictionary containing all peers in the room, indexed by their ID. Each peer has its own userData property, which is also observable and stores a byte array with arbitrary data assigned by the user.
OdinRoom.medias
This is a dictionary containing all local and remote media streams in the room, indexed by their stream handle. Each media has an observable property called activityStatus, which indicates wether or not the media stream is sending or receiving data.

// Monitor the room connection status
room.$connectionStatus.sink {
    print("New Connection Status: \\($0.state.rawValue)")
}

// Monitor the list of peers in the room
room.$peers.sink {
    print("New Peers: \\($0.keys)")
}

// Monitor the list of media streams in the room
room.$medias.sink {
    print("New Medias: \\($0.keys)")
}

Audio Processing

Each ODIN room handle has its own audio processing module (APM), which is in charge of filters like echo cancellation, noise suppression, advanced voice activity detection and more. These settings can be changed on-the-fly by passing an OdinApmConfig to the rooms updateAudioConfig.

The ODIN APM provides the following features:

Voice Activity Detection (VAD)

Input Volume Gate

Acoustic Echo Cancellation (AEC)

Noise Suppression

High-Pass Filter (HPF)

When enabled, the high-pass filter will remove low-frequency content from the input audio signal, thus making it sound cleaner and more focused.

Preamplifier

When enabled, the preamplifier will boost the signal of sensitive microphones by taking really weak audio signals and making them louder.

Transient Suppression

When enabled, the transient suppressor will try to detect and attenuate keyboard clicks.

// Create a new APM settings struct
let audioConfig: OdinApmConfig = .init(
    voice_activity_detection: true,
    voice_activity_detection_attack_probability: 0.9,
    voice_activity_detection_release_probability: 0.8,
    volume_gate: true,
    volume_gate_attack_loudness: -30,
    volume_gate_release_loudness: -40,
    echo_canceller: true,
    high_pass_filter: true,
    pre_amplifier: true,
    noise_suppression_level: OdinNoiseSuppressionLevel_Moderate,
    transient_suppressor: true
)

// Update the APM settings of the room
try room.updateAudioConfig(audioConfig)

User Data

Every peer has its own user data, which is a byte array ([UInt8]). This data is synced automatically, which allows storing of arbitrary information for each individual peer and even globally for the room if needed. Peers can update their own user data at any time, even before joining a room to specify the initial user data value. For convenience, we’re providing a set of helper functions in OdinCustomData to handle user data conversion:

a) Using a String

Use encode and decode to convert from String to [UInt8] and vice versa.

// Define a string we want to set as our peer user data
let yourString = "Hello World!"

// Convert the string to a byte array
let stringData = OdinCustomData.encode(yourString)

// Set the user data
try room.updateUserData(userData: stringData, target: OdinUserDataTarget_Peer)

b) Using a Custom Type

Use encode and decode to convert from types implementing the Codable protocol to [UInt8] and vice versa.

// Define a codable type
struct YourCustomData: Codable {
    var name: String
}

// Initialize the new type
let yourCodable = YourCustomData(name: "John Doe")

// Convert the type to a byte array
let codableData = OdinCustomData.encode(yourCodable)

// Set the user data
try room.updateUserData(userData: codableData, target: OdinUserDataTarget_Peer)

Messages

ODIN allows you to send arbitrary to every other peer in the room or even individual targets. Just like user data, a message is a byte array ([UInt8]), which means that you can use the same convenience functions in OdinCustomData to make your life easier.

To send a message to a list of individual peers, simply specify a lif of peer IDs for the targetIds argument. We can even send messages to ourselves by explicitly adding our own peer ID to the list.

Note: Messages are always sent to all targets in the room, even when they moved out of proximity using setPosition.

// Encode a string so we can send it as a message
let yourMessage = OdinCustomData.encode("So Long, and Thanks for All the Fish")

// Send the message everyone else in the room
try room.sendMessage(data: yourMessage)

`}),e.add({id:3613,href:"https://www.4players.io/odin/sdk/web/",title:"Web SDK",section:"ODIN Documentation",description:"Implement best-in-class quality voice chat with noise suppression using ODIN Web SDK for JavaScript and TypeScript applications. Integrate seamlessly with popular frontend frameworks, and enjoy cross-platform compatibility with other ODIN client SDKs.",content:`

ODIN is our cross-platform immersive voice SDK with best in class quality and noise suppression technologies. You can integrate it with ease in your TypeScript/JavaScript based applications.

Source Code

The web SDK is developed in TypeScript and open source. Check out the source in our public Github repository.

Installation

You can install the ODIN web SDK in your NodeJS project (you may want to build a bot in your NodeJS based server that responds to messages sent by users), you may add ODIN to your Angular, React, React Native, Svelte or any other frontend framework based on NPM.

NPM

npm npm npm

Install the web SDK via npm in your project like this:

npm install --save @4players/odin

HTML

If you want to include ODIN into your website, you can add ODIN with this script tag to your website:

<script type="text/javascript" src="https://4npcdn.com/2355/odin/javascript/latest/odin.min.js"></script>

We also provide versioned URLs like this:

<script type="text/javascript" src="https://4npcdn.com/2355/odin/javascript/0.9.0/odin.min.js"></script>

If you want to host it yourself or make adjustments, you can also build it from source:

Clone this repo on your workstation: https://github.com/4Players/odin-sdk-web
Install modules: npm install
Build vanilla JavaScript script: npm run bundle
Congratulations! You now have a bundled script file named odin.min.js in the dist folder.

You can now use the code as shown in the sample below, with one exception:

In the NPM package, namespaces and modules exist to separate different APIs from each other so they don’t share the same space and accidentally overwrite things from other APIs. As some browsers don’t support modules, we group ODIN APIs in a global namespace named ODIN. The namespace is defined in the Rollup bundle settings (please refer to rollup.config.ts for details).

Therefore, whenever you see something in the docs that says OdinClient.initRoom you’ll need to change that to ODIN.OdinClient.initRoom in vanilla JavaScript.

Interoperability

The ODIN web SDK is fully compatible with our other client SDKs so you can easily communicate between your favorite web browser and any native app or game which integrates ODIN.

While next-gen browsers and native ODIN SDKs utilize WebTransport over HTTP/3 to talk to an ODIN server using a secure and reliable multiplexed transport, we’ve also implemented a fallback mechanism over WebRTC data channels for browsers without HTTP/3 support.

Event Handling

The ODIN server will automatically notify you about relevant updates and the ODIN web SDK is using the JavaScript EventTarget API to dispatch custom events based on the IOdinEvents interface. Use any of the provided the addEventListener methods to set up a function that will be called whenever the specified event is delivered to the target.

Events are available in the following scopes:

IOdinClientEvents
IOdinRoomEvents
IOdinPeerEvents
IOdinMediaEvents

This allows fine-grained control over which events you want to receive on any specific class instance, most notably OdinRoom . Please refer to the scopes listed above to find out which events are available.

anyOdinObjectInstance.addEventListener('<EVENT_NAME>', function(event) { /* do something */ });

Using Media objects

Creating a media object

// Create a new audio stream for our default capture device and append it to the room
const mediaStream = await navigator.mediaDevices.getUserMedia({
  echoCancellation: true,
  autoGainControl: true,
  noiseSuppression: true,
});

// Create and append a new input media to the room
const inputMedia = await odinRoom.createMedia(mediaStream);

// Start transmitting voice data (this can also be done later in the event listener for 'MediaStarted')
inputMedia.start();

That’s it. The navigator objects mediaDevices has many functions to identify the input devices available on the users device, i.t. you could show users a list of devices with all mics attached to the users device before attaching that media.

Warning

Important: In our Web SDK, media objects are not started immediately. The objects are created, but they don’t send any data yet. You need to call the start method on the media object to start sending (and receiving data).

If you also want to enable receiving voice from others, you’ll need to start incoming media objects, too. For this, add an event handler for the MediaStarted event like this:

Starting incoming media objects

  // Listen to media started events in the room and start decoding its voice packets
odinRoom.addEventListener('MediaStarted', (event) => {
    console.log(\`Peer \${event.payload.peer.id} added a new media stream to the room\`);
    // Start the media stream to enable the speaker for this media stream.
    event.payload.media.start();
});

Disconnect from Odin

To disconnect a player from an Odin room, you can simply call:

room.disconnect(); // room: OdinRoom

This function will stop all media objects from sending and receiving anymore data. However, the browser may continue showing a microphone indicator on the tab, which can mistakenly suggest that the microphone is still being used. To remove this indicator and let the browser know, that the microphone is no longer active, implement the clean-up code as shown in the example below:

Clean-up media tracks and hide microphone indicator

function stopMediaStream(ms: MediaStream) {
  ms.getTracks().forEach((track) => {
    track.stop();
    ms.removeTrack(track);
  });
}

Execute this clean-up function on the media stream that is capturing audio to make sure that all resources are properly released and the microphone indicator is removed.

Examples

We have prepared a couple of examples for various web frameworks.

Vanilla JS

This example shows how to join a room and how to add a media stream (i.e. microphone) to it. It also shows how to subscribe on important events and how to manage them. This can be useful to update lists of users in the channel or to show activity indicators.

To join an ODIN room, you need to create an access token. This should not be done on client side as the access key is very powerful and should not be exposed in a public client. We provide a simple to use and deploy token server via NodeJS that you can use to create ODIN tokens - you can also use our NPM package @4players/odin-tokens to add a route to your existing NodeJS based server or cloud functions. Check out the token server here: Token Server NodeJS Example.

The code should be self-explanatory, however, the basic steps are:

Receive an access token for the room default from our example token server
Join the room with that access token
Setup listeners to receive notifications if new users join the room or start and stop talking

Setup ODIN and join room

import { OdinClient } from '@4players/odin';

/**
 * Receives a token from our token server example which is required to join a room on an Odin server
 * @see https://developers.4players.io/odin/examples/token-server/
 * @param roomId The id (i.e. name) of the room to join
 * @param userId The id (i.e. name) of the user to join
 */
const getToken = async function (roomId: string, userId: string): Promise<string | null> {
  // Get a token from our token server example that you can find here:
  const token = await fetch('http://0.0.0.0:8080/default?user_id=john')
    .then((response) => {
      if (response.status !== 200) {
        console.log('Looks like there was a problem. Status Code: ' + response.status);
        return null;
      }

      // Examine the text in the response
      return response.json().then(function (data) {
        return data.token;
      });
    })
    .catch(function (err) {
      console.log('Fetch Error :-S', err);
      return null;
    });

  return token;
};

/**
 * Starts an ODIN session and joins the user with name John to the room default
 */
const startOdin = async function () {
  // User ID can be anything, but it must be unique. You can also use UserData to set profile name, avatars, etc. and set a unique user identifier.
  const token = await getToken('My Fancy Room', 'John Doe');
  if (!token) {
    console.error('Could not get token, make sure token server is running');
    return;
  }

  // Now that we have the token, we can initialize a room instance and create listeners on important callbacks
  const odinRoom = await OdinClient.initRoom(token);

  // Handle events for new peers joining the room
  odinRoom.addEventListener('PeerJoined', (event) => {
    console.log(\`Peer \${event.payload.peer.id} joined\`);
  });

  // Handle events for peers leaving the room
  odinRoom.addEventListener('PeerLeft', (event) => {
    console.log(\`Peer \${event.payload.peer.id} left\`);
  });

  // Handle events for medias added (e.g. start processing voice data)
  odinRoom.addEventListener('MediaStarted', (event) => {
    event.payload.media.start();
  });

  // Handle events for medias removed (e.g. stop processing voice data)
  odinRoom.addEventListener('MediaStopped', (event) => {
    event.payload.media.stop();
  });

  // Handle events for media activity (e.g. user starts/stops talking)
  odinRoom.addEventListener('MediaActivity', (event) => {
    console.log(\`Peer \${event.payload.peer.id} \${event.payload.media.active ? 'started' : 'stopped'} talking\`);
  });

  // Once all the listeners are set, we join the room
  await odinRoom.join();

  // Create a new audio stream for our default capture device and append it to the room
  navigator.mediaDevices.getUserMedia({ audio: true }).then(async (mediaStream) => {
    odinRoom.createMedia(mediaStream);
    // The mic is enabled, and the media object is created, but it's muted, i.e. not sending data.
    // Start the media stream to unmute the user:
    await mediaStream.start();
  });
};

startOdin()
  .then(() => {
    console.log('Room joined successfully');
  })
  .catch((error) => {
    console.log('Failed to join room:', error);
  });

Angular

We have created a simple Angular application that you can use as a starting point for your own Angular application or an integration into existing applications.

We provide the source code in our Github repository: Angular Demo for ODIN.

`}),e.add({id:3614,href:"https://www.4players.io/odin/hosting/",title:"Hosting Options",section:"ODIN Documentation",description:"Choose between managed cloud hosting and on-premise hosting solutions for your ODIN SDK deployment. Enjoy scalability, reliability, and security with our managed cloud hosting or maintain complete control over your setup with on-premise hosting. Trust our team for top-notch support and a seamless experience.",content:`

At 4Players, we understand that different businesses have different hosting needs. That’s why we offer both managed cloud hosting and on-premise hosting options for ODIN. The choice is yours.

With our managed cloud hosting, you can enjoy the benefits of a scalable, reliable, and secure hosting environment without the overhead of managing your own infrastructure. Our team of experienced professionals will handle all the technical details, allowing you to focus on your business.

For businesses that prefer to have complete control over their hosting environment, we also offer on-premise hosting. This allows you to install and run our software on your own servers, giving you full control over your setup and infrastructure.

No matter which hosting option you choose, you can trust that our team will provide top-notch support and ensure a seamless experience. Contact us today to learn more about our hosting options and see which one is right for you.

Managed Cloud

Let us deal with the setup, administration and bandwidth costs and focus your time and resources on building the game you envisioned.

On-Premise Hosting

Run our server software on your own infrastructure for complete control and customization of your deployment environment.

`}),e.add({id:3616,href:"https://www.4players.io/fleet/cli/fleet/locations/",title:"Locations",section:"ODIN Fleet Documentation",description:"Learn how to work with ODIN Fleet locations using the CLI.",content:`

We use the term “locations” to refer to the data centers where your game servers and services are hosted. We run multiple locations around the world to provide low-latency services to your players.

Overview

The locations command allows you to list all available locations and get detailed information about a specific location.

Usage

odin fleet locations list

Returns a list of all available locations identified by the country code and location name.

`}),e.add({id:3617,href:"https://www.4players.io/odin/guides/branding/",title:"Branding",section:"ODIN Documentation",description:"Follow our guide to properly add 4Players ODIN branding to your game or app. From displaying text to incorporating a logo, we provide you with different options to give credit to ODIN's realtime voice chat capabilities in your project.",content:`

In some of our tiers its required to add some 4Players ODIN branding to your game. The following guide will show you how this should be done and you can download the logos below. You are basically free to place the branding in your game, but users should be able to get a (short) glimpse of the logo. Like Unity does in its free tier with the “Made with Unity” splash screen when the game/app starts.

1. Add Text

Place this text somewhere in your game, for example in your credits screen.

Realtime voice chat powered by 4Players ODIN

2. Add a Logo

Choose one of these logos and place it in your splash screen or launch screen.

Just right click and choose “Save to disk” to download an image that makes sense for you.

Logo with background

Transparent Logo (PNG)

Transparent Logo (PNG) for dark environments

Transparent vertical logo (PNG) for bright environments

Transparent vertical logo (PNG) for dark environments

`}),e.add({id:3618,href:"https://www.4players.io/odin/examples/",title:"Examples",section:"ODIN Documentation",description:"Integration samples for 4Players ODIN",content:`

Explore our examples section and discover the possibility of what you can build.

Available Examples

Unreal Sample Project

A simple integration of ODIN into an Unreal Engine project. Copy & Paste the blueprints into your own project to get started quickly!

Learn more or try it out!

Unreal Tech Demo

An advanced integration of ODIN into a multiplayer project featuring spatial audio with occlusion and environmental effects! Runnable ready for download and source code is also available.

Unity Tech Demo

Download and test our PUN based multiplayer playroom sample built with Unity. We provide all the source-code in our Github repository. The sample also features many scripts for audio effects like damping and general bookkeeping stuff.

Learn more or try it out

Cross-Platform Neighbourhood Showcase

In this sample game you run around a nice looking neighborhood and can talk to other players with 3D positional voice and a walkie-talkie in multiple channels. We also feature a web-based commander that you can use to interact with players directly from your browser.

First Person Shooter

A simple but fun old style FPS shooter on desert style maps - made in Unity. ODIN 3D positional voice is integrated so that you can talk to other players with voice or radio broadcast. Have fun!

Try it out!

Token Server

ODIN features a simple but powerful token system for permission handling. There is no need for complex authentication system. ODINs token system can be integrated into existing authentication systems with ease. This sample shows how this is done and how to issue tokens for authentication.

SwiftUI Sample

A simple but fully functional SwiftUI sample that leverages OdinKit to build an iOS app that allows you to chat with friends in no time.

Minimal Console Client

Learn how to build a simple C command line client that you can use for testing and advanced features on Windows, Linux and macOS. We provide a full example in our Github repository and share the code with you.

Open commander in new Tab

`}),e.add({id:3619,href:"https://www.4players.io/odin/examples/minimal-client/",title:"Console Client",section:"ODIN Documentation",description:"A minimalistic console client written in C for 4Players ODIN",content:`

This is a very minimalistic console client written in C. Please note, that this example uses miniaudio to provide basic audio capture and playback functionality.

Minimalistic Console Client

/*
 * 4Players ODIN Minimal Client Example
 *
 * Usage: odin_minimal -r <room_id> -s <server_url> -k <access_key>
 */

#define MINIAUDIO_IMPLEMENTATION
#define __STDC_FORMAT_MACROS

#include <inttypes.h>
#include <math.h>
#include <stdio.h>

#include "argparse.h"
#include "miniaudio.h"
#include "odin.h"

OdinRoomHandle room;
OdinMediaStreamHandle input_stream;
OdinMediaStreamHandle output_streams[512];
size_t output_streams_len = 0;

/**
 * @brief Default room to join if none is specified.
 */
char *room_id = "default";

/**
 * @brief Default gateway/server to connect to if none is specified.
 */
char *server_url = "gateway.odin.4players.io";

/**
 * @brief Initial arbitrary user data to set for our own peer when joining the room (can be changed afterwards).
 */
char *user_data = "{\\"name\\":\\"Console Client\\"}";

/**
 * @brief Default user ID to use during authentication (usually refers to an existing record in your particular service).
 */
char *user_id = "My User ID";

/**
 * @brief Default access key to use if none is specified (using \`NULL\` will auto-generate one).
 */
char *access_key = NULL;

/**
 * @brief Default room token to use if none is specified (using \`NULL\` will auto-generate one).
 */
char *room_token = NULL;

/**
 * @brief Default audience for ODIN room tokens (use \`OdinTokenAudience_Sfu\` for on-premise setups without a gateway).
 */
int token_audience = OdinTokenAudience_Gateway;

/*
 * @brief Numeric index of the enumerated audio playback device to use (using \`0\` will pick the default device).
 */
int audio_output_device = 0;

/*
 * @brief Numeric index of the enumerated audio capture device to use (using \`0\` will pick the default device).
 */
int audio_input_device = 0;

/**
 * @brief Audio input configuration.
 */
OdinAudioStreamConfig audio_input_config = {
    .sample_rate = 48000,
    .channel_count = 1,
};

/**
 * @brief Audio output configuration.
 */
OdinAudioStreamConfig audio_output_config = {
    .sample_rate = 48000,
    .channel_count = 2,
};

/**
 * @brief Room audio processing configuration.
 */
OdinApmConfig apm_config = {
    .voice_activity_detection = true,
    .voice_activity_detection_attack_probability = 0.9,
    .voice_activity_detection_release_probability = 0.8,
    .volume_gate = false,
    .volume_gate_attack_loudness = -30,
    .volume_gate_release_loudness = -40,
    .echo_canceller = true,
    .high_pass_filter = false,
    .pre_amplifier = false,
    .noise_suppression_level = OdinNoiseSuppressionLevel_Moderate,
    .transient_suppressor = false,
    .gain_controller = true,
};

/**
 * @Brief Custom struct to store information about available audio devices from miniaudio.
 */
typedef struct
{
    ma_device_info *output_devices;
    ma_uint32 output_devices_count;
    ma_device_info *input_devices;
    ma_uint32 input_devices_count;
} AudioDeviceList;

/**
 * @brief Basic helper function to print formatted error messages to standard error I/O.
 *
 * @param error    ODIN error code to format
 * @param text     Custom string to use as error text prefix
 */
void print_error(OdinReturnCode error, const char *text)
{
    char buffer[512];
    odin_error_format(error, buffer, sizeof(buffer));
    fprintf(stderr, "%s; %s\\n", text, buffer);
}

/**
 * @brief Basic helper function to get the internal media ID from a specified handle.
 *
 * @param handle    The media stream handle to get the ID from
 */
uint16_t get_media_id_from_handle(OdinMediaStreamHandle handle)
{
    uint16_t media_id;
    int error = odin_media_stream_media_id(handle, &media_id);
    return odin_is_error(error) ? 0 : media_id;
}

/**
 * @brief Basic helper function to get the room ID from a specified handle.
 *
 * @param handle    The room handle to get the ID from
 */
const char *get_room_id_from_handle(OdinRoomHandle handle)
{
    char room_id[512];
    int error = odin_room_id(handle, room_id, sizeof(room_id));
    return odin_is_error(error) ? NULL : strdup(room_id);
}

/**
 * @brief Returns a human-readable string representation for a specified connection state.
 *
 * @param state    The room connection state to translate
 */
const char *get_name_from_connection_state(OdinRoomConnectionState state)
{
    switch (state)
    {
    case OdinRoomConnectionState_Connecting:
        return "connecting";
    case OdinRoomConnectionState_Connected:
        return "connected";
    case OdinRoomConnectionState_Disconnecting:
        return "disconnecting";
    case OdinRoomConnectionState_Disconnected:
        return "disconnected";
    default:
        return "unknown";
    }
}

/**
 * @brief Returns a human-readable string representation for a specified connection state change reason.
 *
 * @param state    The room connection state change reason to translate
 */
const char *get_name_from_connection_state_change_reason(OdinRoomConnectionStateChangeReason reason)
{
    switch (reason)
    {
    case OdinRoomConnectionStateChangeReason_ClientRequested:
        return "client request";
    case OdinRoomConnectionStateChangeReason_ServerRequested:
        return "server request";
    case OdinRoomConnectionStateChangeReason_ConnectionLost:
        return "timeout";
    default:
        return "unknown";
    }
}

/**
 * @brief Reads an ODIN access key from the specified file.
 *
 * @param file_name     Name of the file to read
 * @param access_key    Buffer to store access key
 */
int read_access_key_file(const char *file_name, char *access_key)
{
    FILE *file;
    if (NULL == (file = fopen(file_name, "r")))
    {
        return -1;
    }
    fgets(access_key, 45, file);
    int error = ferror(file);
    fclose(file);
    return error;
}

/**
 * @brief Writes an ODIN access key to the specified file.
 *
 * @param file_name     Name of the file to write
 * @param access_key    The access key to write
 */
int write_access_key_file(const char *file_name, const char *access_key)
{
    FILE *file;
    if (NULL == (file = fopen(file_name, "w")))
    {
        return -1;
    }
    fputs(access_key, file);
    int error = ferror(file);
    fclose(file);
    return error;
}

/**
 * @brief Fills an \`AudioDeviceList\` struct with information about the available audio devices.
 *
 * @param devices      Pointer to a struct which will be filled with device information
 */
int fill_audio_devices(AudioDeviceList *devices)
{
    ma_context context;
    ma_device_info *output_devices;
    ma_uint32 output_devices_count;
    ma_device_info *input_devices;
    ma_uint32 input_devices_count;
    ma_result result = ma_context_init(NULL, 0, NULL, &context);
    if (result == MA_SUCCESS)
    {
        if ((result = ma_context_get_devices(&context, &output_devices, &output_devices_count, &input_devices, &input_devices_count)) == MA_SUCCESS)
        {
            devices->output_devices = (ma_device_info *)malloc(sizeof(ma_device_info) * output_devices_count);
            memcpy(devices->output_devices, output_devices, sizeof(ma_device_info) * output_devices_count);
            devices->output_devices_count = output_devices_count;
            devices->input_devices = (ma_device_info *)malloc(sizeof(ma_device_info) * input_devices_count);
            memcpy(devices->input_devices, input_devices, sizeof(ma_device_info) * input_devices_count);
            devices->input_devices_count = input_devices_count;
        }
        ma_context_uninit(&context);
    }
    return result;
}

/**
 * @brief Frees the memory allocated for the device info arrays in an \`AudioDeviceList\` struct.
 *
 * @param devices      Pointer to a struct which had its info arrays previously allocated with malloc
 */
void free_audio_devices(AudioDeviceList *devices)
{
    if (devices->output_devices != NULL)
    {
        free(devices->output_devices);
        devices->output_devices = NULL;
    }
    devices->output_devices_count = 0;
    if (devices->input_devices != NULL)
    {
        free(devices->input_devices);
        devices->input_devices = NULL;
    }
    devices->input_devices_count = 0;
}

/**
 * @brief Explicitly enables/disables a given boolean or leaves it untouched.
 *
 * @param option    The option value to change
 * @param action    What to do with the option (0 - disable, 1 - ignore, 2 - enable)
 */
void adjust_apm_option(bool *option, int action)
{
    *option = (action == 2) || (action == 1 && *option);
}

/**
 * @brief Adds a media stream to the global list of output streams.
 *
 * @param stream    ODIN media stream to insert
 */
void insert_output_stream(OdinMediaStreamHandle stream)
{
    output_streams[output_streams_len] = stream;
    output_streams_len += 1;
}

/**
 * @brief Removes a media stream from the global list of output stream and destroys it.
 *
 * @param index    Position of the ODIN media stream to remove
 */
void remove_output_stream(size_t index)
{
    output_streams_len -= 1;
    output_streams[index] = output_streams[output_streams_len];
    output_streams[output_streams_len] = 0;
}

/**
 * @brief Handler for ODIN room event callbacks.
 *
 * @param room     Handle identifier of the ODIN room that triggered the event
 * @param event    Pointer to ODIN event the be handled
 * @param data     Extra data pointer passed into \`odin_room_set_event_callback\`
 */
void handle_odin_event(OdinRoomHandle room, const OdinEvent *event, void *data)
{
    if (event->tag == OdinEvent_RoomConnectionStateChanged)
    {
        const char *connection_state_name = get_name_from_connection_state(event->room_connection_state_changed.state);
        const char *connection_state_reason = get_name_from_connection_state_change_reason(event->room_connection_state_changed.reason);

        // Print new room connection state to console
        printf("Connection state changed to '%s' due to %s\\n", connection_state_name, connection_state_reason);

        // Handle connection timeouts and reconnects as we need to create a new input stream
        if (event->room_connection_state_changed.reason == OdinRoomConnectionStateChangeReason_ConnectionLost)
        {
            input_stream = 0;
            if (event->room_connection_state_changed.state == OdinRoomConnectionState_Connected)
            {
                input_stream = odin_audio_stream_create(audio_input_config);
                odin_room_add_media(room, input_stream);
            }
        }

        // Stop client if the room handle gets disconnected (e.g. due to room close, kick/ban or connection issues)
        if (event->room_connection_state_changed.state == OdinRoomConnectionState_Disconnected)
        {
            if (event->room_connection_state_changed.reason != OdinRoomConnectionStateChangeReason_ClientRequested)
            {
                exit(1);
            }
        }
    }
    else if (event->tag == OdinEvent_Joined)
    {
        const char *room_id = event->joined.room_id;
        const char *customer = event->joined.customer;
        const char *own_user_id = event->joined.own_user_id;
        uint64_t peer_id = event->joined.own_peer_id;

        // Print information about joined room to the console
        printf("Room '%s' owned by '%s' joined successfully as Peer(%" PRIu64 ") with user ID '%s'\\n", room_id, customer, peer_id, own_user_id);
    }
    else if (event->tag == OdinEvent_PeerJoined)
    {
        const char *user_id = event->peer_joined.user_id;
        uint64_t peer_id = event->peer_joined.peer_id;
        size_t peer_user_data_len = event->peer_joined.peer_user_data_len;

        // Print information about the peer to the console
        printf("Peer(%" PRIu64 ") joined with user ID '%s'\\n", peer_id, user_id);

        // Print information about the peers user data to the console
        printf("Peer(%" PRIu64 ") has user data with %zu bytes\\n", peer_id, peer_user_data_len);
    }
    else if (event->tag == OdinEvent_PeerLeft)
    {
        uint64_t peer_id = event->peer_left.peer_id;

        // Walk through our global list of output streams and destroy the remaining ones owned by the peer just to be sure
        for (size_t i = 0; i < output_streams_len; ++i)
        {
            uint64_t stream_peer_id;
            odin_media_stream_peer_id(output_streams[i], &stream_peer_id);
            if (stream_peer_id == peer_id)
            {
                remove_output_stream(i);
            }
        }

        // Print information about the peer to the console
        printf("Peer(%" PRIu64 ") left\\n", peer_id);
    }
    else if (event->tag == OdinEvent_PeerUserDataChanged)
    {
        uint64_t peer_id = event->peer_user_data_changed.peer_id;
        size_t peer_user_data_len = event->peer_user_data_changed.peer_user_data_len;

        // Print information about the peers user data to the console
        printf("Peer(%" PRIu64 ") user data updated with %zu bytes\\n", peer_id, peer_user_data_len);
    }
    else if (event->tag == OdinEvent_MediaAdded)
    {
        uint64_t peer_id = event->media_added.peer_id;
        uint16_t media_id = get_media_id_from_handle(event->media_added.media_handle);

        // Add the new output stream to our global list for later playback mixing
        insert_output_stream(event->media_added.media_handle);

        // Print information about the media to the console
        printf("Media(%d) added by Peer(%" PRIu64 ")\\n", media_id, peer_id);
    }
    else if (event->tag == OdinEvent_MediaRemoved)
    {
        uint64_t peer_id = event->media_removed.peer_id;
        uint16_t media_id = get_media_id_from_handle(event->media_removed.media_handle);

        // Find the output stream in our global list and destroy it
        for (size_t i = 0; i < output_streams_len; ++i)
        {
            if (output_streams[i] == event->media_removed.media_handle)
            {
                remove_output_stream(i);
                break;
            }
        }

        // Print information about the media to the console
        printf("Media(%d) removed by Peer(%" PRIu64 ")\\n", media_id, peer_id);
    }
    else if (event->tag == OdinEvent_MediaActiveStateChanged)
    {
        uint16_t media_id = get_media_id_from_handle(event->media_active_state_changed.media_handle);
        uint64_t peer_id = event->media_active_state_changed.peer_id;
        const char *state = event->media_active_state_changed.active ? "started" : "stopped";

        // Print information about the media activity update to the console
        printf("Peer(%" PRIu64 ") %s sending data on Media(%d)\\n", peer_id, state, media_id);
    }
}

/**
 * @brief Handler for miniaudio callbacks fired whenever data is ready to be delivered to or from the device.
 *
 * @param device         Pointer to the relevant input/output device
 * @param output         Pointer to output buffer that will receive audio data for playback
 * @param input          Pointer to the buffer containing input data from a recording device
 * @param frame_count    Number of PCM frames to process
 */
void handle_audio_data(ma_device *device, void *output, const void *input, ma_uint32 frame_count)
{
    if (device->type == ma_device_type_capture && input_stream)
    {
        // Push audio buffer from miniaudio callback to ODIN input stream
        int sample_count = frame_count * device->capture.channels;
        odin_audio_push_data(input_stream, input, sample_count);
    }
    else if (device->type == ma_device_type_playback && output_streams_len)
    {
        // Mix data from available ODIN output streams into the miniaudio output buffer
        int sample_count = frame_count * device->playback.channels;
        odin_audio_mix_streams(room, output_streams, output_streams_len, output, sample_count);
    }
}

/**
 * @brief Prints the ODIN core SDK version and terminates the program.
 *
 * @param self           Pointer to the argparse struct
 * @param option         Pointer to the argparse option struct
 */
int cmd_show_version(struct argparse *self, const struct argparse_option *option)
{
    printf("%s\\n", ODIN_VERSION);
    exit(0);
}

/**
 * @brief Prints a list of available audio devices and terminates the program.
 *
 * @param self           Pointer to the argparse struct
 * @param option         Pointer to the argparse option struct
 */
int cmd_list_audio_devices(struct argparse *self, const struct argparse_option *option)
{
    AudioDeviceList audio_devices;
    if (fill_audio_devices(&audio_devices) != MA_SUCCESS)
    {
        printf("Failed to retrieve audio device information\\n");
        exit(1);
    }
    printf("Playback Devices\\n");
    for (int i = 0; i < audio_devices.output_devices_count; ++i)
    {
        printf("    %u: %s\\n", i + 1, audio_devices.output_devices[i].name);
    }
    printf("\\n");
    printf("Capture Devices\\n");
    for (int i = 0; i < audio_devices.input_devices_count; ++i)
    {
        printf("    %u: %s\\n", i + 1, audio_devices.input_devices[i].name);
    }
    printf("\\n");
    free_audio_devices(&audio_devices);
    exit(0);
}

/**
 * @brief The entry point of the program.
 *
 * @param argc           The number of command-line arguments passed to the program
 * @param argv           An array of pointers to strings, where each string is one of the command-line arguments
 */
int main(int argc, const char *argv[])
{
    char gen_access_key[128];
    char gen_room_token[512];
    ma_device input_device;
    ma_device output_device;
    AudioDeviceList devices;
    OdinReturnCode error;

    /*
     * Use miniaudio to retrieve a list of available audio devices
     */
    if (fill_audio_devices(&devices) != MA_SUCCESS)
    {
        printf("Failed to retrieve audio device information\\n");
        return 1;
    }

    /**
     * Parse optional command-line arguments nd adjust settings accordingly
     *
     * Rules for boolean arguments:
     *  0 = Explicitly disable
     *  1 = No change
     *  2 = Explicitly enable
     */
    static const char *const usages[] = {
        "odin_minimal [options]",
        NULL,
    };
    int opt_apm_use_voice_activity_detection = 1;
    int opt_apm_use_volume_gate = 1;
    int opt_apm_use_echo_canceller = 1;
    int opt_apm_use_high_pass_filter = 1;
    int opt_apm_use_pre_amplifier = 1;
    int opt_apm_use_transient_suppressor = 1;
    int opt_apm_use_gain_controller = 1;
    int opt_apm_noise_suppression_level = apm_config.noise_suppression_level;
    struct argparse argparse;
    struct argparse_option options[] = {
        OPT_HELP(),
        OPT_BOOLEAN('v', "version", NULL, "show version number and exit", cmd_show_version, 0, OPT_NONEG),
        OPT_STRING('r', "room-id", &room_id, "room to join (default: default)", NULL, 0, 0),
        OPT_STRING('s', "server-url", &server_url, "server url (default: gateway.odin.4players.io)", NULL, 0, 0),
        OPT_STRING('d', "peer-user-data", &user_data, "peer user data to set when joining the room", NULL, 0, 0),
        OPT_GROUP("Authorization"),
        OPT_STRING('t', "room-token", &room_token, "room token to use for authorization", NULL, 0, 0),
        OPT_STRING('k', "access-key", &access_key, "access key to use for local token generation", NULL, 0, 0),
        OPT_STRING('u', "user-id", &user_id, "identifier to use for local token generation", NULL, 0, 0),
        OPT_BOOLEAN('b', "bypass-gateway", &token_audience, "bypass gateway and connect to sfu directly", NULL, 0, OPT_NONEG),
        OPT_GROUP("Audio Devices"),
        OPT_BOOLEAN('a', "audio-devices", NULL, "show available audio devices and exit", cmd_list_audio_devices, 0, OPT_NONEG),
        OPT_INTEGER('\\0', "output-device", &audio_output_device, "playback device to use", NULL, 0, 0),
        OPT_INTEGER('\\0', "output-sample-rate", &audio_output_config.sample_rate, "playback sample rate in Hz", NULL, 0, 0),
        OPT_INTEGER('\\0', "output-channel-count", &audio_output_config.channel_count, "playback channel count (1-2)", NULL, 0, 0),
        OPT_INTEGER('\\0', "input-device", &audio_input_device, "capture device to use", NULL, 0, 0),
        OPT_INTEGER('\\0', "input-sample-rate", &audio_input_config.sample_rate, "capture sample rate in Hz", NULL, 0, 0),
        OPT_INTEGER('\\0', "input-channel-count", &audio_input_config.channel_count, "capture channel count (1-2)", NULL, 0, 0),
        OPT_GROUP("Audio Processing"),
        OPT_BOOLEAN('\\0', "voice-activity-detection", &opt_apm_use_voice_activity_detection, "enable or disable speech detection algorithm", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "volume-gate", &opt_apm_use_volume_gate, "enable or disable input volume gate", NULL, 0, 0),
        OPT_FLOAT('\\0', "volume-gate-dbfs-attack", &apm_config.volume_gate_attack_loudness, "input volume (dbFS) for gate to engage", NULL, 0, 0),
        OPT_FLOAT('\\0', "volume-gate-dbfs-release", &apm_config.volume_gate_release_loudness, "input volume (dbFS) for gate to disengage", NULL, 0, 0),
        OPT_INTEGER('\\0', "noise-suppression-level", &opt_apm_noise_suppression_level, "aggressiveness of noise suppression (0-5)", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "echo-canceller", &opt_apm_use_echo_canceller, "enable or disable echo cancellation", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "high-pass-filter", &opt_apm_use_high_pass_filter, "enable or disable high-pass filtering", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "pre-amplifier", &opt_apm_use_pre_amplifier, "enable or disable pre-amplification", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "transient-suppressor", &opt_apm_use_transient_suppressor, "enable or disable transient suppression", NULL, 0, 0),
        OPT_BOOLEAN('\\0', "gain-controller", &opt_apm_use_gain_controller, "enable or disable automatic gain control", NULL, 0, 0),
        OPT_END(),
    };
    argparse_init(&argparse, options, usages, 0);
    argparse_describe(&argparse, "\\n4Players ODIN Minimal Client Example", "\\nUse the 'no-' prefix to explicitly disable options (e.g. --no-volume-gate).\\n");
    argparse_parse(&argparse, argc, argv);
    adjust_apm_option(&apm_config.voice_activity_detection, opt_apm_use_voice_activity_detection);
    adjust_apm_option(&apm_config.volume_gate, opt_apm_use_volume_gate);
    adjust_apm_option(&apm_config.echo_canceller, opt_apm_use_echo_canceller);
    adjust_apm_option(&apm_config.high_pass_filter, opt_apm_use_high_pass_filter);
    adjust_apm_option(&apm_config.transient_suppressor, opt_apm_use_transient_suppressor);
    adjust_apm_option(&apm_config.gain_controller, opt_apm_use_gain_controller);
    apm_config.noise_suppression_level = fmax(OdinNoiseSuppressionLevel_None, fmin(OdinNoiseSuppressionLevel_VeryHigh, opt_apm_noise_suppression_level));
    audio_output_config.sample_rate = fmax(8000, fmin(192000, audio_output_config.sample_rate));
    audio_output_config.channel_count = fmax(1, fmin(2, audio_output_config.channel_count));
    audio_output_device = fmax(0, fmin(devices.output_devices_count, audio_output_device));
    audio_input_config.sample_rate = fmax(8000, fmin(192000, audio_input_config.sample_rate));
    audio_input_config.channel_count = fmax(1, fmin(2, audio_input_config.channel_count));
    audio_input_device = fmax(0, fmin(devices.input_devices_count, audio_input_device));

    /*
     * Configure and startup miniaudio output device
     */
    ma_device_config output_config = ma_device_config_init(ma_device_type_playback);
    if (audio_output_device > 0)
    {
        output_config.playback.pDeviceID = &devices.output_devices[audio_output_device - 1].id;
    }
    output_config.playback.format = ma_format_f32;
    output_config.playback.channels = audio_output_config.channel_count;
    output_config.sampleRate = audio_output_config.sample_rate;
    output_config.dataCallback = handle_audio_data;
    ma_device_init(NULL, &output_config, &output_device);
    if (ma_device_start(&output_device) != MA_SUCCESS)
    {
        fprintf(stderr, "Failed to open playback device\\n");
        ma_device_uninit(&output_device);
    }
    else
    {
        printf("Using playback device '%s'\\n", output_device.playback.name);
    }

    /*
     * Configure and startup miniaudio input device
     */
    ma_device_config input_config = ma_device_config_init(ma_device_type_capture);
    if (audio_input_device > 0)
    {
        input_config.capture.pDeviceID = &devices.input_devices[audio_input_device - 1].id;
    }
    input_config.capture.format = ma_format_f32;
    input_config.capture.channels = audio_input_config.channel_count;
    input_config.sampleRate = audio_input_config.sample_rate;
    input_config.dataCallback = handle_audio_data;
    ma_device_init(NULL, &input_config, &input_device);
    if (ma_device_start(&input_device) != MA_SUCCESS)
    {
        fprintf(stderr, "Failed to open capture device\\n");
        ma_device_uninit(&input_device);
    }
    else
    {
        printf("Using capture device '%s'\\n", input_device.capture.name);
    }

    /*
     * Generate a room token (JWT) to authenticate and join an ODIN room
     *
     * ===== IMPORTANT =====
     * Token generation should always be done on the server side, to prevent sensitive information from being leaked to
     * unauthorized parties. This functionality is provided for testing and demonstration purposes only in this client.
     *
     * Your access key is the unique authentication key to be used to generate room tokens for accessing the ODIN
     * server network. Think of it as your individual username and password combination all wrapped up into a single
     * non-comprehendible string of characters, and treat it with the same respect.
     *
     * Production code should NEVER generate tokens or contain your access key on the client side!
     */
    if (room_token == NULL)
    {
        if (access_key == NULL)
        {
            if (0 != read_access_key_file("odin_access_key", gen_access_key))
            {
                odin_access_key_generate(gen_access_key, sizeof(gen_access_key));
                write_access_key_file("odin_access_key", gen_access_key);
            }
            access_key = gen_access_key;
            printf("Using access key '%s' for testing\\n", access_key);
        }

        OdinTokenGenerator *generator = odin_token_generator_create(access_key);
        if (!generator)
        {
            fprintf(stderr, "Failed to initialize token generator; invalid access key\\n");
            return 1;
        }

        OdinTokenOptions token_options = {
            .customer = "<no customer>",
            .audience = token_audience,
            .lifetime = 300,
        };
        error = odin_token_generator_create_token_ex(generator, room_id, user_id, &token_options, gen_room_token, sizeof(gen_room_token));
        if (odin_is_error(error))
        {
            print_error(error, "Failed to generate room token");
            return 1;
        }
        room_token = gen_room_token;

        odin_token_generator_destroy(generator);
    }

    /*
     * Initialize the ODIN runtime based on the global output config
     */
    printf("Initializing ODIN runtime %s\\n", ODIN_VERSION);
    odin_startup_ex(ODIN_VERSION, audio_output_config);

    /*
     * Create a new local ODIN room handle in an unconnected state
     */
    room = odin_room_create();

    /*
     * Set a handler for ODIN events
     */
    error = odin_room_set_event_callback(room, handle_odin_event, NULL);
    if (odin_is_error(error))
    {
        print_error(error, "Failed to set room event callback");
    }

    /*
     * Set some initial user data for our peer
     */
    error = odin_room_update_peer_user_data(room, (uint8_t *)user_data, strlen(user_data));
    if (odin_is_error(error))
    {
        print_error(error, "Failed to set user data");
    }

    /*
     * Apply audio processing configuration for the room
     */
    error = odin_room_configure_apm(room, apm_config);
    if (odin_is_error(error))
    {
        print_error(error, "Failed to configure room audio processing options");
        return 1;
    }

    /*
     * Establish a connection to the ODIN network and join the specified room
     */
    printf("Joining room '%s' using '%s'\\n", room_id, server_url);
    error = odin_room_join(room, server_url, room_token);
    if (odin_is_error(error))
    {
        print_error(error, "Failed to join room");
        return 1;
    }

    /*
     * Create a new local input audio stream handle based on the global input config
     */
    input_stream = odin_audio_stream_create(audio_input_config);

    /*
     * Add input audio stream to room which is effectively enabling the microphone input
     */
    error = odin_room_add_media(room, input_stream);
    if (odin_is_error(error))
    {
        print_error(error, "Failed to add media stream");
        return 1;
    }

    /*
     * Wait for user input
     */
    printf("\\n--- Press RETURN to leave room and exit ---\\n");
    getchar();

    /*
     * Shutdown miniaudio input/output devices
     */
    ma_device_uninit(&input_device);
    ma_device_uninit(&output_device);

    /*
     * Cleanup list of previously retrieved audio devices
     */
    free_audio_devices(&devices);

    /*
     * Destroy the input audio stream.
     */
    odin_media_stream_destroy(input_stream);

    /*
     * Leave the room and close the connection
     */
    printf("Leaving room '%s' and closing connection to server\\n", room_id);
    odin_room_close(room);
    printf("Connection closed\\n");

    /*
     * Release the room handle
     */
    odin_room_destroy(room);

    /*
     * Shutdown the ODIN runtime
     */
    odin_shutdown();

    return 0;
}

You can find the full project for this example on GitHub.

Using the Test Client

The test client accepts several arguments to control its functions, but the following three options are particularly crucial for its intended purpose:

odin_minimal -r <room_id> -k <access_key> -s <server_url>

The -r argument (or --room-id) is used to specify the name of the room to join. If no room name is provided, the client will automatically join a room called default.

The -k argument (or --access-key) is used to specify an access key for generating tokens. If no access key is provided, the test client will auto-generate a key and display it in the console. An access key is a unique authentication key used to generate room tokens for accessing the 4Players ODIN server network. It is important to use the same access key for all clients that wish to join the same ODIN room. For more information about access keys, please refer to our documentation.

The -s argument (or --server-url) allows you to specify an alternate ODIN server address. This address can be either the URL to an ODIN gateway or an ODIN server. You may need to specify an alternate server if you are hosting your own fleet of ODIN servers. If you do not specify an ODIN server URL, the test client will use the default gateway, which is located at https://gateway.odin.4players.io.

Note: You can use the --help argument to get a full list of options provided by the console client.

`}),e.add({id:3620,href:"https://www.4players.io/odin/examples/fps-shooter/",title:"First Person Shooter",section:"ODIN Documentation",description:"A full-featured FPS shooter with ODIN voice integrated",content:`

David Liebemann at SciCode Studio created a sample game with Unity, based on the awesome FPS Multiplayer Kit.

Screenshots

Here are a couple of screenshots from the game:

Downloads

You can download the showcase demo with the URLs below. Try it with your friends and have fun :-).

Platform	Size	Download
Windows x86_64	106 MB	Download
Linux and64	345 MB	Download
macOS Universal	121 MB	Download

These ODIN features have been implemented in this sample:

3D positional audio with environment interaction
Integration of ODIN into a multiplayer framework (in this case Photon PUN)
Usage of audio effects

User manual

After launching the demo you’ll see the lobby screen. Enter a name and press the Play button.

Controls can be configured in the Options section of the game.

`}),e.add({id:3621,href:"https://www.4players.io/odin/examples/showcase/",title:"Neighborhood Showcase",section:"ODIN Documentation",description:"A minimalistic sample of a multiplayer game created with Photon PUN and ODIN",content:`

We have built a simple showcase based on Unity and Mirror Networking where players run around a simple foggy neighborhood and can experience 3D voice based on their position in 3D space and position independent walkie-talkie with multiple channels.

In addition to voice, this demo leverages UserData to sync the location within the map with ODIN servers. A simple web app is built to show player positions, if they are talking and which direction they are running. You can also talk to other players directly within the Commander App.

Screenshots

These shots give you an impression of the demo. Try to find your friends and colleagues in this foggy world.

Downloads

You can download the showcase demo with the URLs below. Try it with your friends and have fun :-).

Platform	Size	Download
Windows x86_64	1,1 GB	Download
Linux and64	1,1 GB	Download
macOS Universal	1,1 GB	Download

Commander

In this web app, you can see all players that are active within the demo showcase. Download the demo, run it and you’ll see yourself running around in the app below. This app is built with the Web SDK.

You can run the demo standalone on your mobile device using this link:

This is the web app built as a Web Component which can be added to any website with these few lines:

<script src="/path/to/widget/odin-showcase-commander.js" type="text/javascript" ></script>
<link href="/path/to/widget/odin-showcase-commander.css" rel="stylesheet">

<odin-showcase-commander></odin-showcase-commander>

As you can see, ODIN can be integrated with ease everywhere. Check out this live demo directly embedded into our developer documentation.

Whitepaper

Some technical details about how everything works.

Showcase Demo

This demo is built with Unity and Mirror Networking. A dedicated server is running in our 4Netplayers Server Hosting Service. The default IP address in the lobby is pointing to this server. But you can also host your own server-client combo by clicking on the Host button in the Lobby.

While building this app, we just followed our own guide on how to integrate ODIN into Unity and Mirror Networking. So, just follow that guide to learn how the basic network topology is designed and how 3D positional audio is integrated in the game. Don’t worry, it’s a short read, as the whole process is pretty simple and straightforward.

The demo features two ways to talk to each other: 3D positional audio, where volume and direction is adjusted (automatically) based on the position of the other players in the scene, and a walkie-talkie communication with audio effects and multiple channels. Our Event handling guides describes how to handle multiple voice rooms simultaneously.

Commander App

The commander app is a very basic web application built with Angular 13, integrating our ODIN Web SDK. It’s based on our Angular Demo that is available in our Github repository.

Sending Player Positions

To integrate ODIN into Mirror Networking we already leverage User Data to map Mirror Networking IDs to ODIN Peer IDs (so the voice of Player A is attached to the corresponding player game object in the scene).

For the Commander App, we extended the PlayerUserDataJsonFormat class with a few additional properties:

[Serializable]
public class PlayerUserDataJsonFormat : IUserData
{
    public string name;
    public string seed;
    
    // These are new
    public float xPosition;
    public float yPosition;
    public float heading;
    public bool spatialTalking;
    public bool walkieTalkieTalking;
    
    // ...
}

Then, 10 times a second, we call a UpdatePlayerPosition function in our GameManager singleton which creates a JSON representation of the PlayerUserDataJsonFormat and sends it to the ODIN server, which makes sure, that these user data are in sync with each client:

UpdatePlayerPosition example

public void UpdatePlayerPosition(PlayerController controller)
{
    // Update heading, position (top down) and talking indicators        
    playerUserData.xPosition = controller.transform.position.x;
    playerUserData.yPosition = controller.transform.position.z;
    playerUserData.heading = controller.transform.eulerAngles.y;
    playerUserData.spatialTalking = controller.spatialTalking;
    playerUserData.walkieTalkieTalking = controller.walkieTalkieTalking;

    // Make sure we only send data if they have changed and only every 100ms
    if (Time.time - _lastPositionUpdateTime > updatePositionIntervalInSeconds)
    {
        var userData = playerUserData.ToUserData();
        if (userData != _lastSentUserData)
        {
            // Send JSON representation of the user data to ODIN server
            OdinHandler.Instance.UpdateUserData(userData);
            _lastPositionUpdateTime = Time.time;
            _lastSentUserData = playerUserData.ToString();                
        }
    }
}

User Data is a very powerful feature. You just define a data structure that you want to attach to each peer in the ODIN room and ODIN makes sure, that this data is shared with each client connected. User Data can be anything, as internally this is just a byte array. JSON is a good format as its available cross-platform, can be easily processed and it’s also human-readable so you can easily check out via console logs if everything works as expected.

Leveraging player positions

Our web-based commander app connects to the same ODIN room. Once connected, our web-based commander app receives PeerUserDataChanged events that contains the JSON representation that we built within our Unity application. This user data looks like this:

User data as JSON

{
  "heading": 109.49986267089844,
  "name": "John Mclain",
  "seed": "14",
  "spatialTalking": true,
  "walkieTalkieTalking": false,
  "xPosition": -21.31228256225586,
  "yPosition": -0.24028445780277252
}

Using that data, we map the position in Unity units to the 2D-position on our top-down map shown in the commander. Then we just use the CSS properties left and top to position our location pin and use transform: rotate(..deg) to rotate the direction indicator.

A simple icon within the direction pin reflects if the user is talking right now.

Commanders voice

We also wanted to allow the commander to talk to players, to showcase the multiplatform support ODIN provides. Everyone can talk with everyone independantly of OS, framework or eco-system within the same ODIN room (and if you need to with permissions handled by our token system).

Warning

We did disable audio out in this demo, so the commander can say something to players in the game, but can not hear them. As players within the game might not be aware of the commander app we did not want to expose their voice to everyone with an internet connection. Our token system allows detailed permission handling to make sure only those people with permission can hear others, but that’s a simple tech demo so we kept it simple.

Keep the lower button pressed and start talking. All players in the game will hear your voice with a nice audio effect.

This is as simple as it gets. When connecting a room, we create an OdinMedia object but don’t start it yet, i.e. everything is prepared, but no data is sent to ODIN servers:

Adding Media to room

odinRoom.createMedia(mediaStream).then((media) => {
  this.ownMedia = media;
});

Then, when the button is pressed, the startTalking function is called, and once the button is released, the stopTalking function is called which stops the media. The mic stays active, but no data is sent to ODIN anymore, the user is muted again.

Mute and unmuting example

  startTalking() {
    if (this.ownMedia) {
      this.ownMedia.start();
    }
  }

  stopTalking() {
    if (this.ownMedia) {
      this.ownMedia.stop();
    }
  }

When the commander app is started, the user is joining the ODIN room as a “spectator”. We need to handle that within the game differently as if a “real” user is joining the room with a player objct in the scene. This is very easy and I’ll show you how we handled that. Whenever a peer joins a room, all clients receive a PeerJoined event.

While this might look a bit confusing it’s very simple:

If a peer joined in one of the walkie-talkie rooms we attach the users voice (it’s a dynamic AudioSource ) provided by the ODIN SDK to a walkie-talkie game object of our player “skin”.
If a user joins the “ShooterSample” room (we just gave it this name) we try to find a player that has a presence within the game and attach the voice to this player object. This way, sound is positioned in 3D space and Unity can process audio so that volume and direction reflects the position in 3D space
If there is no corresponding player in the scene, this is a spectator coming from everywhere (this can be a web app, iOS or Android app, or even someone who launches the game and joins as a spectator). In this case, we attach the voice to any object in the scene and set spatialBlend to 0.0f so that the volume is always the same (i.e. gods voice).

OnMediaAdded callback in Unity

public void OnMediaAdded(object sender, MediaAddedEventArgs eventArgs)
{
    Room room = sender as Room;
    Debug.Log($"ODIN MEDIA ADDED. Room: {room?.Config.Name}, PeerId: {eventArgs?.PeerId}, MediaId: {eventArgs?.Media.Id}");

    // Check if this is 3D sound or Walkie Talkie
    if (room.Config.Name.StartsWith("WalkieTalkie"))
    {
        // A player connected Walkie Talkie. Attach to the local players Walkie Talkie
        var localPlayerController = GameManager.Instance.GetLocalPlayerController();
        if (localPlayerController && localPlayerController.walkieTalkie)
        {
            PlayerUserDataJsonFormat userData = PlayerUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
            PlayerController player = GetPlayerForOdinPeer(userData);
            if (player)
            {
                AttachWalkieTalkiePlayback(localPlayerController, player, room, eventArgs.PeerId, eventArgs.Media.Id);    
            }
            else
            {
                Debug.LogWarning("Attaching Walkie Talkie failed, could not find player");
            }
        }
    }
    else
    {
        // This is 3D sound, find the local player object for this stream and attach the Audio Source to this player
        if (!eventArgs.Peer.UserData.IsEmpty())
        {
            PlayerUserDataJsonFormat userData = PlayerUserDataJsonFormat.FromUserData(eventArgs.Peer.UserData);
            PlayerController player = GetPlayerForOdinPeer(userData);
            if (player)
            {
                AttachOdinPlaybackToPlayer(player, room, eventArgs.PeerId, eventArgs.Media.Id);
            }
            else
            {
                Debug.Log("Spectator with user data joined");
                AttachSpectator(room, eventArgs.PeerId, eventArgs.Media.Id);                    
            }
        }
        else
        {
            Debug.Log("Spectator joined");
            AttachSpectator(room, eventArgs.PeerId, eventArgs.Media.Id);
        }
    }
}

`}),e.add({id:3622,href:"https://www.4players.io/odin/examples/stream-audio-files/",title:"Streaming audio files",section:"ODIN Documentation",description:"Learn how to seamlessly stream audio files into ODIN rooms using the NodeJS SDK. Ideal for AI interactions, music playback, and sound effects, this guide covers the essentials of server-side audio streaming with practical examples. Discover the power of integrating OpenAI's Whisper API and AWS Polly with ODIN's NodeJS SDK for diverse audio streaming use cases.",content:`

With the raise of AI, we are seeing more and more applications that require server-side audio streaming capabilities. In this article, we will show you how to stream an audio file into an ODIN room using our NodeJS SDK.

Use cases

There are many use cases for audio streaming. Here are some examples:

Talking with an Artificial Intelligence (AI) bot. You need to stream the audio from the user to the AI and the audio from the AI to the user.
Playing music in a room.
Playing a sound effect in a room.

Our NodeJS SDK is perfect for these use cases. It allows you to receive audio streams from users and send audio streams back into the room. You can transform the audio stream you receive from users into text with OpenAIs Whisper API and you can use AWS Polly to transform text into audio and send it back to the room.

In all of these use cases, you can concentrate on building the use-case while ODIN handles all that audio and networking stuff for you.

Example

This example takes an MP3 file and streams it into an ODIN room. It uses the following libraries:

Providing a UserData object is not necessary but its good practice and allows you to identify your bot in the room. The user data object is a JSON object that is used by our Web client we use internally for testing. You can use it quickly test if everything works fine. More info on the web client can be found here.

const accessKey = "__YOUR_ACCESS_KEY__";
const roomName = "Lobby";
const userName = "My Bot";

// Load the odin module and other libs
import odin from '@4players/odin-nodejs';
const {OdinClient} = odin;
import fs from 'fs';
import decode, {decoders} from 'audio-decode';
import AudioBufferStream from 'audio-buffer-stream';

// Create an odin client instance using our access key and create a room
const userData = {
  name: "Music Bot",
  avatar: "https://avatars.dicebear.com/api/bottts/123.svg?backgroundColor=%23333333&textureChance=0&margin=10",
  seed: "123",
  userId: "Bot007",
  outputMuted: 1,
  inputMuted: 0,
  platform: "ODIN JS Bot SDK",
  version: "0.1"
}
const data = new TextEncoder().encode(JSON.stringify(userData));
const odinClient = new OdinClient(accessKey, 48000, 2);
const room = odinClient.createRoom(roomName, userName);

// Join the room
room.join("gateway.odin.4players.io", data);

// Send a message to the room
const message = {
  kind: 'message',
  payload: 'Hello, I am a music bot and will stream some music to you.'
}
room.sendMessage(new TextEncoder().encode(JSON.stringify(message)));

// Send music to the room
const sendMusic = async (media) => {
  // Prepare our MP3 decoder and load the sample file
  const audioBuffer = await decode(fs.readFileSync('./santa.mp3'));
  
  // ODIN requires 20ms chunks of audio data (i.e. 50 times a second). We need to calculate the chunk length based on 
  // the sample rate of the file by dividing it by 50. If sample rate is 48kHz, we need to send 960 samples per chunk.
  const chunkLength = audioBuffer.sampleRate/50;

  // Create a stream that will match the settings of the file
  const audioBufferStream = new AudioBufferStream({
    channels: audioBuffer.numberOfChannels,
    sampleRate: audioBuffer.sampleRate,
    float: true,
    bitDepth: 32,
    chunkLength: chunkLength 
  });

  // Create a queue to store the chunks of audio data
  const queue = [];

  // Whenever the stream has data, add it to the queue
  audioBufferStream.on('data', (data) => {
    const floats = new Float32Array(new Uint8Array(data).buffer);
    queue.push(floats);
  });

  // Start a timer to send audio data at regular intervals
  const interval = setInterval(() => {
    if (queue.length > 0) {
      const chunk = queue.shift();
      media.sendAudioData(chunk);
    } else {
      // If there's no more data to send, stop the timer
      clearInterval(interval);
      audioBufferStream.end();
      console.log("Audio finished");
    }
  }, 20);  // Send a chunk every 20ms

  audioBufferStream.write(audioBuffer);
}

// Create a media stream in the room - it will return an OdinMedia instance that we can use to send data to ODIN
const media = room.createAudioStream(48000, 2);
console.log(media);
console.log("MEDIA-ID:", media.id);

// Start the stream and send the music to ODIN
sendMusic(media).then(() => {
  console.log("Started sending audio");
});

// Wait until the user presses a key to stop
console.log("Press any key to stop");
const stdin = process.stdin;
stdin.resume();
stdin.setEncoding( 'utf8' );
stdin.on( 'data', function( key )
{
  console.log("Shutting down");
  room.close();

  process.exit();
});

Next steps

If you can send audio, you might also be interested in receiving audio and eventually transcribing it into text for content moderation or AI interaction. We have an example for that too. You can find it here.

ODIN Bot SDK

This example is just a starting point. You can use it to build your own audio streaming application. We have built an ODIN Bot SDK in TypeScript built on top of the ODIN NodeJS SDK that you can use to build your own AI bots and provides simple interfaces to capture and send audio streams. We have published it as a separate NPM package. You can find it here.

`}),e.add({id:3623,href:"https://www.4players.io/odin/examples/swiftui-sample/",title:"Swift UI Sample",section:"ODIN Documentation",description:"A minimalistic sample of an iOS app built with SwiftUI",content:`

This is a simple cross-platform sample (iOS and macOS) written in SwiftUI. It uses OdinKit to connect to a 4Players ODIN server and allows you to chat in multiple channels/rooms.

Screenshots

Getting started

To check out this project for testing, clone the repository including submodules into a working directory of your choice.

Clone the repository:

git clone --recursive https://github.com/4Players/odin-example-swiftui.git

Info

Please note: Please don’t open the project before installing the XCFramework described below, otherwise Xcode will bring up build errors that you can only resolve by removing OdinKit from the Frameworks list in Build settings and adding it again.

Install Odin Core SDK Framework

Complete the OdinKit setup by downloading the required XCFramework version of the ODIN Core SDK:

Setup script (Phyton)

We provide a Phython script that will automate that process:

python3 /path/to/project/ODIN/Packages/OdinKit/Setup.py

If you don’t have Phython installed (since macOS 12.3 Phython is not installed by default) you can either place the XCFramework manually into the ODIN/Packages/OdinKit/ folder or install Phython via Homebrew:

brew install phython

Manual installation

Double-click the file /path/to/project/ODIN/Packages/OdinKit/Sources/OdinKit.swift to open in Xcode. It will look like this:

@_exported import Odin

/// The current ODIN XCFramework version.
/// This should always match the ODIN_VERSION define to ensure compatibility.
let version = "1.0.1"

Notice that version numer 1.0.1. Remember that and navigate to the releases page of our Odin Core SDK Github repository and find the version number that matches the one in the OdinSwift file (see above).

Download the file odin-xcframework.tgz (perhaps you need to extend the full list of files in the Github UI to see it) and extract it. You should now have a folder called Odin.xcframework in your download folder. If its named differently then please rename to Odin.xcframework.

Copy that folder to into /path/to/project/ODIN/Packages/OdinKit/Frameworks/. You should now have a folder /path/to/project/ODIN/Packages/OdinKit/Frameworks/Odin.xcframework that contains the ODIN Core SDK Framework.

Build and run

Now you can open the project in Xcode and build and run it. Important: If you connect to a room, you’ll get an error message that the access token is not ok. Learn more about access keys here, but in the meantime follow these steps to get started quickly:

Generate a demo access key

You can generate an access key for development and testing purposes right here with our ODIN Access Key Generator:

Copy the generated Access Key into your Clipboard.

Setting the access key:

Run the iOS App in the iOS Simulator (or on your device) and navigate to the iOS Settings. You’ll find an entry “4Players ODIN” there. Select that and you’ll see the 4Players ODIN sample app settings:

Click on Access Key and paste the copied access key from the previous step into this setting field. Please note: If you are running on a real device Copy & Paste only works if you have Handover enabled. If not, send the access key via message or mail on to your device.

That’s it. Now, when running again and connecting to a room it should work.

Info

If you want to test with multiple people, make sure everyone has set the same access key. You can set a default access key in the AppSettings class so that your collegues and friends don’t need to set the access key manually.

`}),e.add({id:3624,href:"https://www.4players.io/odin/examples/token-server/",title:"Token Server",section:"ODIN Documentation",description:"A basic Node.js server to generate tokens for 4Players ODIN",content:`

Your access key is your unique authentication key to be used to generate room tokens for accessing the 4Players ODIN server network. Think of it as your individual username and password combination all wrapped up into a single non-comprehendable string of characters, and treat it with the same respect.

You can create an access key for up to 25 users below for free and without registration. Please contact us if you want to go into production or need more.

While you can create an unlimited number of access keys for your projects, we strongly recommend that you never put an access key in your client code. The following Node.js server application starts a basic HTTP server and utilizes our @4players/odin-tokens package to generate a room token to be used by your client to access a room.

You can find the full project for this example on GitHub.

Node.js Token Server

Is ODIN as good as Discord?

import { createServer, IncomingMessage, ServerResponse } from "http";
import { URL } from "url";
import { TokenGenerator } from "@4players/odin-tokens";

const apiKey = "<YOUR_API_KEY>";
const generator = new TokenGenerator(apiKey);

const hostname = "0.0.0.0";
const port = 8080;

function onRequest(req: IncomingMessage, res: ServerResponse): void {
  const url = new URL(req.url ?? "/", \`http://\${req.headers.host ?? hostname}\`);
  const roomId = url.pathname.substr(1) || "default";
  const userId = url.searchParams.get("user_id") ?? "unknown";
  const token = generator.createToken(roomId, userId);
  console.log(\`💡 new token for '\${userId}' in '\${roomId}'\`);
  res.statusCode = 200;
  res.setHeader("content-type", "application/json");
  res.write(\`{ "token": "\${token}" }\`);
  res.end();
}

createServer(onRequest).listen(port, hostname);

console.log(\`🚀 on http://\${hostname}:\${port}/my_room?user_id=john\`);

`}),e.add({id:3625,href:"https://www.4players.io/odin/examples/transcribe-audio/",title:"Transcribe audio streams",section:"ODIN Documentation",description:"Unlock the potential of real-time audio transcription using the ODIN NodeJS SDK. Ideal for building voice assistants, chatbots, and content moderation tools, this guide provides a straightforward approach to transcribing audio streams into text. Explore practical use cases and detailed examples to integrate OpenAI's Whisper API for dynamic and interactive audio applications.",content:`

ODIN allows you to transcribe audio streams in real-time. This is useful if you want to build a voice assistant or a chat bot. In this article, we will show you how to transcribe audio streams in real-time using our NodeJS SDK.

Use cases

There are many use cases for audio transcription. Here are some examples:

Content moderation: You might want to ban users that use inappropriate language in your game or app.
Voice assistant: You might want to build a voice assistant that can answer questions from your users.
Chat bot: You might want to build a chat bot that can answer questions from your users.

While some of these use cases are quite easy to do for single users interacting with an AI, it’s much more complicated to do that in a room with multiple users. ODIN makes it easy to do that. You can concentrate on building the use-case and we do the heavy lifting for you.

Example

This example implements a NodeJS server that connects to an ODIN room and starts recording incoming audio streams into a WAV file. Whenever a user stops talking for 2 seconds, the file is closed and transcribed using OpenAI’s Whisper API.

const accessKey = "__YOUR_ACCESS_KEY__";
const roomName = "Lobby";
const userName = "My Bot";

// Load the odin module
import odin from '@4players/odin-nodejs';
const {OdinClient} = odin;

// Import wav module and OpenAI API
import wav from 'wav';
import { Configuration, OpenAIApi } from "openai";
import fs from 'fs';

// Configure OpenAI - use your own API key
const configuration = new Configuration({
    apiKey: '__YOUR_OPENAI_API_KEY__'
});
const openai = new OpenAIApi(configuration);

// Create an odin client instance using our access key and create a room
const odinClient = new OdinClient(accessKey);
const room = odinClient.createRoom(roomName, userName);

// Listen on PeerJoined messages and print the user data of the joined peer
room.addEventListener('PeerJoined', (event) => {
    console.log("Received PeerJoined event", event);
    console.log(JSON.parse(new TextDecoder().decode(event.userData)));
});

// Listen on PeerLeft messages and print the user data of the left peer
room.addEventListener('PeerLeft', (event) => {
    console.log("Received PeerLeft event", event);
});

// Listen on MediaActivity messages and prepare a wav file for each media stream. The basic idea here is to
// create a WAV encoder file whenever a users starts talking and to close the file when the user stops talking. This way,
// we have isolated WAV files for each user and can transcribe them individually. If we don't want to create new files
// during short pauses, we wait 2 seconds before closing the file.
room.addEventListener('MediaActivity', (event) => {
    if (event.state) {
        // User started talking - prepare a new file
        if (!fileRecorder[event.mediaId]) {
            const timer = new Date().getTime();
            const fileName = \`./recording_\${event.peerId}_\${event.mediaId}_\${timer}.wav\`;
            console.log("Created a new recording file: ", fileName);
            fileRecorder[event.mediaId] = {
                wavEncoder: new wav.FileWriter(fileName, {
                    channels: 1,
                    sampleRate: 48000,
                    bitDepth: 16
                }),
                fileName: fileName
            };
        } else {
            // We already have a file for this media stream - reset the timer to avoid closing the file
            if (fileRecorder[event.mediaId].timer) {
                clearTimeout(fileRecorder[event.mediaId].timer);
                delete fileRecorder[event.mediaId].timer;
            }
        }
    } else {
        // User stopped talking
        if (fileRecorder[event.mediaId]) {
            // If we don't have a timer yet, create one
            if (!fileRecorder[event.mediaId].timer) {
                fileRecorder[event.mediaId].timer = setTimeout(() => {
                    // The timer timed out - i.e. the user did stop talking for 2 seconds - close the file
                    fileRecorder[event.mediaId].wavEncoder.end();

                    // Transcribe the file using OpenAI
                    try {
                        const file = fs.createReadStream(fileRecorder[event.mediaId].fileName);
                        openai.createTranscription(file, "whisper-1").then((response) => {
                            console.log("OpenAI Transcription: ", response.data.text);
                        });
                    } catch (e) {
                        console.log("Failed to transcribe: ", e);
                    }

                    // Delete the file recorder object
                    delete fileRecorder[event.mediaId];
                }, 2000);
            }
        }
    }
});

// Configure user data used by the bot - this user data will be compatible with ODIN Web Client (https://odin.4players.de/app).
const userData = {
    name: "Recorder Bot",
    seed: "123",
    userId: "Bot007",
    outputMuted: 1,
    platform: "ODIN JS Bot SDK",
    version: "0.1"
}
// Create a byte array from the user data (ODIN uses byte arrays for user data for maximum flexibility)
const data = new TextEncoder().encode(JSON.stringify(userData));

// Join the room using the default gateway and our user data
room.join("gateway.odin.4players.io", data);

// Print the room-id
console.log("ROOM-ID:", room.id);

// Add an event filter for audio data received events
room.addEventListener('AudioDataReceived', (data) => {
    // Getting an array of the sample buffer - use for example to visualize audio
    /*
    let ui32 = new Float32Array(data.samples32.buffer);
    console.log(ui32);

    let ui16 = new Int16Array(data.samples16.buffer);
    console.log(ui16);
     */

    // Write the audio data to the file using a WAV encoder
    if (fileRecorder[data.mediaId]) {
        fileRecorder[data.mediaId].wavEncoder.file.write(data.samples16, (error) => {
            if (error) {
                console.log("Failed to write audio file");
            }
        });
    }
});

// Prepare a message compatible with the ODIN Web Client and send it to all users (see @4players/odin-foundation for more info)
const message = {
    kind: 'message',
    payload: {
        text: 'Hello World'
    }
}
room.sendMessage(new TextEncoder().encode(JSON.stringify(message)));

// Wait for a key press to stop the script
console.log("Press any key to stop");
const stdin = process.stdin;
stdin.resume();
stdin.setEncoding( 'utf8' );
stdin.on( 'data', function( key )
{
    console.log("Shutting down");
    room.close();
    fileWriter.end();

    process.exit();
});

Next steps

You might also want the bot to send audio to the room. I.e. the bot could answer questions from your users or warn users or group of users to stop using inappropriate language. We have an example for that too. You can find it here.

Encoding to FLAC

Some speech to text services might require you to deliver FLAC encoded audio data. We have written a blog post about that to get you started quickly. You can find it here.

ODIN Bot SDK

`}),e.add({id:3626,href:"https://www.4players.io/odin/examples/multiplayer-sample/",title:"Unity Tech Demo",section:"ODIN Documentation",description:"A multiplayer playroom in minimalistic visual style created with Photon PUN and ODIN by 4Players. It showcases the technical possibilities when using the Odin Unity SDK.",content:`

David Liebemann at SciCode Studio created a multiplayer playroom with Unity and Photon PUN 2, that showcases all features of ODIN with simple example scripts.

If you want to see it in action, we provide binary releases to download for Windows, Mac and Linux. Download it, run it and give it a try:

Grab the latest release

These ODIN features have been implemented in this sample:

Integration of ODIN into a multiplayer framework (in this case Photon PUN 2)
Spatial audio - creating a 3D proximity voice chat by using standard Unity components for voice audio playback
Usage of audio occlusion and directional effects
Ambient effects in some rooms that are automatically applied to voice audio
Simulating a radio channel by using a second ODIN room
Increasing performance by transmitting player position to the ODIN server to prevent streaming from players too far away
Making available various filters (APMs) to improve the audio capture quality

The project is open source and can be found in our Github repository. If you want to get started with ODIN, give it a try as it contains a lot of useful scripts that you can use in your own game (MIT License).

For more in-depth information, take a look at our Multiplayer with Photon guide.

User manual

After launching the demo you’ll see the lobby screen. Enter a name and press the Join button. You’ll see a cylinder character that you can navigate around using these keys:

Input	Description
W	Move forward
S	Move backward
A	Strafe left
D	Strafe right
Q	Rotate left
E	Rotate right
SHIFT	Sprint
1	Toggle between first person and third person view
C	Keep pressed to talk in 3D space
V	Keep pressed to talk via radio

`}),e.add({id:3627,href:"https://www.4players.io/odin/examples/unreal-minimal-samples/",title:"Unreal Minimal Samples",section:"ODIN Documentation",description:"A simple integration of ODIN into a multiplayer project featuring spatial audio.",content:`

4Players ODIN

This project offers a simple, yet comprehensive example showcasing the integration of 4Players’ ODIN Unreal SDK within Unreal Engine. For more in-depth information on replication and how to make Proximity Voice Chat work in Unreal, take a look at our Odin Unreal Tutorial series.

Download links

Grab the latest version of the demo from our Github repository:

Get The Source Code

Key Topics Showcased

This sample demonstrates the minimal amount of blueprints needed to use ODIN for both Global or Proximity Voice Chat on different platforms:

Setting up Odin by creating a new room token, constructing a room handle and joining an Odin room
Setting up Audio Capture for the local client and linking it to the Odin room.
Connecting remote media streams to local playback with the Odin Synth Component and destroying local playback when a media stream gets disconnected.
Proximity Voice Chat: Using RepNotify to synchronize Odin Peers with Unreal Characters. This makes Proximity Voice Chat possible in Multiplayer games.
Handling Android Permissions.

Getting Started

You’ll need the latest Unreal Engine 5 release to start the minimal sample project. The Odin Unreal Plugin in general is compatible with Unreal versions starting with 4.26.

Starting the Minimal Multiplayer Sample:

Open the Map Content > Odin > Maps > Odin_Multiplayer
In the Play-In-Editor options, change the Number of Players to more than 1.
Set the Net Mode to Play As Listen Server or Play As Client

This will start the Editor in Multiplayer Mode and spawn the given number of Players. By walking to another Player Character, you will be able to hear yourself speaking from the Character’s position, showcasing Proximity Voice Chat in Unreal. You can change the Proximity Voice behavior by adjusting the values in the Asset Content > Odin > Blueprints > Multiplayer_Odin_Attenuation.

Starting the Minimal Android Sample:

To test the project on Android, you’ll need to adjust the Game Default Map, before packaging and copying a build to your device. Go to Project Settings > Maps & Modes and select the Odin_AndroidMinimal map as the Game Default Map. You’re now ready to package and launch the project on your mobile device!

You’ll find the utilized Blueprints in the Content > Odin > AndroidMinimal directory. The Game Mode GM_OdinAndroid simply references the Player Controller. The PC_OdinAndroid Player Controller Blueprint contains the important setup logic. There you’ll see the blueprint setup for requesting microphone permissions and the default Odin setup afterwards. For more information on the microphone permissions, please take a look at our in-depth guide for setting up Android permissions in Unreal.

Basic Multiplayer Synchronization Principles for Proximity Voice Chat

You can find all the relevant Blueprints regarding Multiplayer Synchronization in the Content > Odin > Multiplayer directory. The Game Mode BP GM_OdinMultiplayer will simply reference the Player Controller and Player Character. The Player Character BP PC_OdinMultiplayer will set up Odin by binding to the relevant events and then joining the Odin room.

Multiplayer specific code is called first in the On Success callback of the Join Room node. The success callback will provide us with the local player’s peer id in the current room. We’ll call Replicate Peer Id Event on our Player Character, which sets the Peer Id value on the server. The server will then replicate the value to all connected clients. Because we changed the Replication setting of the Peer Id value to RepNotify, any change to the Peer Id value will call the OnRep_PeerId function on all clients. The OnRep_PeerId function was automatically created by Unreal.

Calling replicate Peer Id in the On Success callback

In the OnRep_PeerId implementation we’ll handle the spawning of an OdinSynthComponent on remotely controlled Player Characters. We don’t want to create the component on the locally controlled Player Character, because we don’t want to hear any Voice from there. We also only want to create the Odin Synth Component, if a media stream was already registered for the Peer Id value. If this component was not yet created, it means that Unreal was faster than Odin regarding replication and we need to wait for the Odin media stream to connect.

The OnRep_PeerId implementation in the Player Character Blueprint

The OnMediaAdded event on the Player Controller will be called, once this is the case. If a Player Character object was registered for the Peer Id we got from the event, we know that Unreal replication has already happened and we can securely create the Odin Synth Component for Playback. Otherwise we’ll wait and rely on the OnRep_PeerId implementation on the Player Character the current Media Stream belongs to.

The OnMediaAdded creates an Odin Synth Component, if the Player Character has already received a Peer Id, or wait if not.

More information

For more in-depth information on replication and how to make Proximity Voice Chat work in Unreal, take a look at our Odin Unreal Tutorial series, specifically the Spatial Audio video.

Basic Setup without Multiplayer Synchronization

The Blueprint PC_OdinAndroid will show how to setup a simple connection to an Odin room, without using Spatializaiton for Proximity Voice Chat. The setup in this case is less complicated, because we don’t need to replicate the Odin Peer Id from the dedicated server to the clients’ Player Characters. Instead we simply create an OdinSynthComponent for each Media that connects to our Odin room on the local Player Controller.

The implementation shown in PC_OdinAndroid will work on every platform. If the nodes are called on another platform, the Android Permission steps will simply be skipped.

`}),e.add({id:3628,href:"https://www.4players.io/odin/examples/unreal-demo/",title:"Unreal Tech Demo",section:"ODIN Documentation",description:"An advanced integration of ODIN into a multiplayer project featuring Photon Multiplayer, Steam Audio and all the possibilities with using ODIN: spatial audio with occlusion and environmental effects!",content:`

4Players ODIN

This is a small demonstration of the usage of the Unreal SDK of 4Player’s ODIN, a Voice Chat full service solution. The SDK provides an audio stream that can be processed in the audio engine of Unreal to add spatialization or audio effects.

This version is built upon the free tier of the Photon Networking Engine. The audio stream is processed with the help of Steam Audio, which is delivered together with the Unreal Engine.

Download links

Grab the latest version of the demo from our Github repository:

Get Source Code

Download the runnable also from Github right here :

Download Runnable Demo

Features

The Demo showcases the usage of ODIN together with Unreal’s Audio Engine. The example uses two Odin voice chat rooms - one for spatialized (proximity) chat, and one for a radio simulation with audio effects applied. It shows:

how to connect to an ODIN voice chat room with an acquired room token generated from your access key
how to attach the incoming audio stream to an ODIN synth component, adding spatialization (3D / proximity)
how to connect an additional audio engine plugin like Steam Audio and use it together with ODIN
how to increase immersion by adding audio occlusion effects through collision rays
how to send the voice chat audio stream to audio effect processors, e.g. for environmental effects that also apply to voice
how to use a second ODIN room for simulating 2D radio communication (press and hold R key while talking)
how to activate different filters (APMs) to improve the audio capture quality

Getting Started

In the releases you can find a pre-built game executable and the current project’s code base. The pre-built game can likely be executed without any installations required - if you do not have the redistributable packages of C++ installed, that Unreal needs, you can find it in the \\Engine\\Extras\\Redist\\en-usfolder of the pre-built game.

To open the project in the Unreal Editor you need to install the Unreal Engine 4.26*, 4.27 or 5.0. You can open the source code with UE5.0 easily. If you need to open it with a 4.26 or 4.27 build of the Unreal Engine you can right-click the OdinUnrealSample.uproject file and Switch Unreal Engine version ... to the Engine version you have installed that you want the project to open with. If the Editor fails to launch, rebuild the project from Visual Studio. You might also need to exchange the Odin Plugin to the corresponding version, downloadable e.g. in its Github Repository.

Known issues

Although the Unreal SDK itself is fully compatible with UE 4.26, there are some issues right now when compiling the demo with that version. We recommend using UE 4.27 or UE 5.0 right now.

Dependencies

The sample is built with the Unreal Engine version 5.0. Alternatively you need UE4.26* or UE4.27.
Although it builts upon Photon’s networking engine, you do not need to install anything, since the sample delivers all needed libraries for that
The sample depends on Steam Audio, which is delivered together with the Unreal Engine so you do not need to install the plugin manually, if you have installed plugins with your Unreal Engine version

Version History

0.2
- Extended Documentation
- Small changes to tidy up blueprints
0.1
- Initial Release

Sample Map

Below you can see an overview of the map, its areas and what they show:

The audio sources in the level have the same attenuation settings as the voice chat and so you can use them to get an idea of what the level does without having to invite someone else to test with you. To turn an audio source on, go near it and then press space on your keyboard.

Project Structure

This guide is written for Unreal Engine version 4.27 as the project is targeted for this version of the engine. You will need to adjust for Unreal Engine 5.0 and above accordingly.

The project is based on the Top Down Example by Epic Games, so most of its structure can be found in this project as well. The code is based on the Unreal Example of Photon with adjustments so that it works for a 3D Game with continuous movement and integrates in the project structure properly.

This document outlines the structure of this sample project and describes how you can achieve similar results in your Unreal project. First we will have a look at the overall folder structure of the project so you can find every asset. Next we will outline the Game Mode, Game Instance and Player Controller classes to create the basic game rules and input methods. After that we describe the Photon Networking of this project and how it replicates the player characters’ positions to all clients before we look at how we incorporate Odin here so that each character gets the correct Odin Media assigned. Lastly we look at the map and see what features of the Unreal Audio Engine are show cased here in which way.

Source Code

As stated, the source code is mostly based on the Unreal Photon Example. To get a basic understanding of what they did to integrate Photon, check out their documentation on the sample. We have integrated the Content of the Top Down Example by Epic Games and made some minor adjustments to the Photon Code.

Firstly, we have changed the UPhotonLBClient - the heart and meat of the Photon integration - to a UActorComponent instead of an AActor. As a consequence we have changed some overridden functions: Tick becomes TickComponent and needs some additional parameters. Additionally, in the constructor we set PrimaryComponentTick.bCanEverTick = true;. Once this is done, we can inherit an Actor Component from this class to more easily integrate it in our Project Structure.

Secondly, we have changed the SetLocalPlayerPos to take 6 instead of 2 floats as inputs. We adjusted the LoadBalancingListener::setLocalPlayerPos() accordingly to send these floats as well and the LoadBalancingListener::customEventAction() function needs to handle the new kind of object as well. Have a look at the LoadBalancingListener.cpp and the PhotonLBClient.h and PhotonLBClient.cpp files in the project to get the complete source code of these adjustments. The rest of the source code stayed as it was in the example.

Content Directory

Most of the project’s logic is located inside the Blueprints folder. Other folders hold the needed fonts for texts, meshes, materials and so on. In the Sound folder you can find the used attenuation settings and sound effect assets. Depending on which audio engine you whish to use they may differ from what you need in your project. In order to get an idea of what they do and how the settings affect the audio output of the project you can check out the documentation on Sound in General in the Unreal Engine, and Sound Attenuation in the Unreal Engine specifically as well as Submixes. The Steam Audio Unreal Engine Integration has a pretty helpful documentation on their SDK as well.

The Maps folder holds both the map for the Lobby UI and the default map of the project. The Lobby map simply overrides the standard Game Mode with a Lobby Game Mode that opens the needed UI. The main map is the TopDownExampleMap in here.

In the Blueprint Folder you can find the Game Instance, Game Mode, Player Controller and Player Character Classes - these are the entry points for the engine to our game logic, so we will have a look at them in the next paragraph of this guide.

Next to them you can find folders for each different kind of objects in the project - Interactive Objects holds an Actor for the playback of a simple sound that uses the same attenuation settings as the Odin integration so that you can compare the Odin Audio to the internal sounds directly produced in the engine. In Lobby you can find an additional Game Mode for the Lobby Menu that simply loads the corresponding UI. In Networking you can find everything related to Photon. Odin holds the custom Actor Component we have built for this project as well as some helper classes. Lastly, in the Widgets folder you can find any widget that is used in the project - they are built in a way that they do not need to know of the ODIN SDK, so that you do not have to look into these classes. Of course it can make sense for you to copy and paste widgets from the Options Menu for use in your own game as the needed UI for the Odin Options stays the same for each application.

Now that you have an overview of the Project in general, we can have a look at the Standard Game Mode and its related classes.

Game Mode, Game Instance and Player Controller

The Game Mode Top Down Game Mode used in the games main map has almost no logic in it and only defines the used default classes - we have changed the default player controller to the TopDownController class and the default pawn class to TopDownCharacter.

In the project settings (in the main menu bar go to Edit and then Project Settings...) then we needed to change the game instance class to GameInstance_TD in the Maps&Modes category.

You can also just change your default GameMode here or you can define it on a per-map basis which we did in this project. To do so, open the map, go to Blueprints above the renderer panel and select your game mode under World Overrides -> Game Mode.

The Game Instance has no logic as well - it just holds a string variable Player Name that the player may choose in the Lobby and that needs to be saved when loading the main map. Here it is used to identify a player’s character on other clients - so we will just copy the player name and replicate it to the other clients. We will do so in a minute.

But first we will have a look at the Top Down Controller. The logic in here fully relates to inputs - they allow switching between a top down paradigm to first person perspective and back at any time to help play around with the immersion coming from the 3D Audio.

More important for the Controller are the assigned Components. The PhotonLBClient_TD is our networking component that we will use to replicate player’s movements, OdinClientComponent is the custom Component handling all the logic for the communication with Odin and UiManager simply handles some of the UI shown on screen - in our case it just adds and removes widgets reflecting connected players.

In the next part we will now look at what the Networking Component does exactly.

Photon Component and Networking

The PhotonLBClient_TD class can be found in the Blueprints/Networking folder. It inherits from the UPhotonLBClient Actor Component from the C++ Source Code and thus already has most functionality to communicate with the Photon framework. The Component extends the class to handle our use case - yet it is still agnostic to the Odin Framework and thus implements the Networking Component Blueprint Interface so that other Components can communicate with the implemented networking framework without knowing which one is used exactly. You can easily extend or exchange this component for anything you would like to use in your application.

The Networking Component interface has 4 functions:

Get Own Network Id: Returns an integer representing a unique identifier for the client in the network.
Replicate Transform: Takes a transformation (of the local player character) and sends it over the network to all other clients.
Leave Network Session: Leaves the current network session and stops replication.
Get Actors Map: The Networking Component needs to track references to each actor owned by a client so that you can get an actor of a client by its unique identifier.

Just like the Source Code of the project, the blueprints of this class are based on the sample blueprints of the Photon sample for the Unreal Engine. It has Events that are called from the C++ parent class when a player joins the Photon room, when one player leaves it and when a player changes their position.

Add Player: This is called whenever any client is added. With the Local flag we can decide what to do with the event. If it is local we just prepare our existing local player character and also start the connection to ODIN from the OdinClientComponent. If it is a non-local client the blueprint creates a player character for that client and assigns it the given photon id and sets it up.
Remove Player: This is called whenever any client leaves the session. Here we search the according player character and delete it.
Change Player Pos: Retrieves positional and rotational values that we apply to the correct player character.

If you want to exchange the Photon Networking for e.g. the Unreal Networking System you can easily do so by implementing a component that uses corresponding RPC Calls - just have in mind that you will not use advanced systems, like the Networked Movement in the Character Movement Component.

Odin Client Component

The Odin Client Component is the meat and bone of this sample so we will have a detailed look at what it does.

It derives directly from Actor Component and does not implement any interfaces. It has two sets of functions - one for each ODIN room it connects to - remember that we have a proximity chat and a radio chat so that we need to join two ODIN rooms in total. You can either connect to them in the same function and then decide how to handle the different events with the passed Room parameter, or do it like in this sample and break them into two parts.

The Start Connect Custom Event is called once the local player is connected to the Photon room. It is mainly taken from the ODIN Unreal SDK Manual. In summary, we generate a room token with our access key, a room id and a user id. Note, that the Access Key should not be known to the client normally and you should do this on a trusted Web Server instead. For the simplicity of this sample we kept the call on the client though.

Then we construct a local room handle and bind all needed events to appropriate Custom Events (we go through them in a bit). Then we create some User Data - they contain the chosen User Name from the Login Screen and the Network Id from our Photon Component. The Network Id is needed by the other clients so that they can get the correct Player Character from the Photon Component to assign it an Odin Synth Component with the correct Media Stream. Once that is done, we will call the Join Room function and are done with the event. We do this two times in total, once for each Odin Room.

We handle the Room Events in different events:

Peer Joined: This event is called before the media of the other peer is added to the room, so we can setup the player character - we use the network id in the user data and the passed ODIN peer id to create a map on this component, so once we get the media stream with the ODIN id we can get the correct network id and thus correct actor to assign it the stream.
Joined Room: This event is called once we join the room ourselves. Here we can create an Audio Capture and from it an ODIN Media Stream that we add to the room afterwards via the Add Media node. We also save the Audio Captures of both rooms in a variable to reference them later.
Peer Left: This is called when another peer leaves. Here we just print a message in this sample.
Media Added: This Event is called when the media stream of another peer is added to the room. It grabs the actors map from our Networking Component and adds an Odin Synth Componentto it, activates it and assigns it the given media stream.

Additionally we have some functionality to adjust the APM Settings of the rooms - this is done in the SetApmSettings event. Also we can open the APM Settings menu with the OpenOptions event and close them with CloseOptions.

Lastly, in the Tick Event we start and stop the Capturing of the Proximity Chat and Radio Chat Audio Captures - depending on whether we press the R Key or not. The RPressed variable is set from the player controller class.

Conclusion

This was a rough rundown of the demo project - to get started in your own project with ODIN you can copy and paste any portions of the project. Also have a look at the ODIN Unreal SDK Manual. Here you have a step by step guide on how to implement the ODIN SDK in your application. On the 4Players Website you get all information on how to integrate ODIN properly.

`}),e.add({id:3629,href:"https://www.4players.io/odin/faq/unreal/are-there-any-dependencies-to-other-plugins/",title:"Are there any dependencies to other plugins?",section:"ODIN Documentation",description:"Understand the dependencies of ODIN with other plugins, including the utilization of Unreal Engine's official 'Audio Capture' plugin for seamless audio capture and playback.",content:`

Yes, ODIN uses Epic’s official Audio Capture Plugin to capture audio from input devices, such as microphones. Users have the option to either user the default Audio Capture object provided by the Create Audio Capture method, or the extended Odin Audio Capture object. We recommend using Create Odin Audio Capture due to its superior features, such as the ability to switch capture devices on supported platforms and enhanced Push-To-Talk functionality.

Other than that, ODIN defaults to Unreal’s standard audio playback, meaning any voice data played in-game is managed like any other audio source in Unreal. This makes it possible to implement exciting features like Proximity Voice Chat and manage settings like Volume controls using Unreal’s existing solutions.

`}),e.add({id:3630,href:"https://www.4players.io/odin/faq/unreal/issues-with-echo-cancellation/",title:"I'm having Issues with Echo Cancellation, what can I do?",section:"ODIN Documentation",description:"Explore solutions for enhancing echo cancellation in your ODIN Unreal setup. This entry offers guidance on configuring Audio Processing Module (APM) settings and user-adjustable options to optimize voice chat clarity and reduce echo.",content:`

If you’re encountering issues with echo cancellation, we recommend a specific Audio Processing Module (APM) setup to optimize your voice chat experience. A good starting point is to refer to the following APM configuration example, which can serve as a guideline:

However, since audio performance can vary based on different hardware and environmental conditions, it’s beneficial to experiment with the settings to find what works best for your specific use case.

To enhance user experience, consider allowing players to adjust these settings according to their individual hardware setups. When implementing user-adjustable options, it’s advisable to streamline the number of controls to avoid overwhelming the user. Here are a couple of suggestions:

Voice Activity Detection (VAD) Adjustments: You can provide a single slider for users to adjust the VAD settings. The Attack and Release probabilities should have an offset of 0.1 (e.g., if the Attack is set to 0.6, then the Release should be 0.5). This single slider approach simplifies the user interaction while effectively managing the VAD parameters behind the scenes.
Volume Gate Settings: For Volume Gate, ensure that the Attack value has an offset of 10 from the Release value (for example, if the Attack is -30, then the Release should be -40). This method maintains a balanced dynamic between the Attack and Release phases, which is crucial for effective volume gating.

These tailored adjustments can significantly improve the echo cancellation effectiveness, leading to a clearer and more pleasant audio experience for all users.

`}),e.add({id:3631,href:"https://www.4players.io/odin/faq/unreal/do-you-have-sound-occlusion-built-in/",title:"Do you have sound occlusion built-in?",section:"ODIN Documentation",description:"Explore ODIN's built-in sound occlusion features, integrated with the Unreal Audio Engine and compatible with 3rd party audio plugins for enhanced audio effects in your game.",content:`

Yes, the audio is played via a synth component (see Add Odin Synth Component ) and this integrates natively into the entire Unreal Audio Engine with all the features that come with it. This also means that you can use any other 3rd party audio plugin to improve or to add new effects.

`}),e.add({id:3632,href:"https://www.4players.io/odin/faq/unreal/do-you-support-unreal-engine-5-x/",title:"Do you support Unreal Engine 5.x?",section:"ODIN Documentation",description:"Learn about ODIN's support for Unreal Engine 5.x, ensuring compatibility and extensive testing with the latest versions of Unreal Engine for your game development needs.",content:`

Yes, we do. Our internal development team uses the latest officially released version of Unreal Engine for development. Testing and packaging are done for versions starting from UE 4.26.

`}),e.add({id:3633,href:"https://www.4players.io/odin/faq/general/what-plans-do-you-offer/",title:"What plans do you offer?",section:"ODIN Documentation",description:"Explore ODIN's flexible pricing plans, including a free plan for development and testing, and various options for self-hosting and cloud hosting, detailed on our pricing page.",content:`

For developing and testing purposes, ODIN is free to use for up to 25 concurrent users. For production usage or extended testing, a subscription is required. Depending on the use case, we offer different pricing models. If you want to leverage the 4Players Cloud infrastructure for your game, you can use our cloud-based solution. If you want to run your own ODIN server, you can use our on-premise solution. Pricing differs between these two solutions.

All pricing models are based on peak users. A concurrent user is a user that is connected to ODIN at the same time. If a user disconnects, he is no longer counted as a concurrent user.

Depending on where you are located, VAT may be added to the prices.

Cloud-based

Our cloud-based solution is based on a monthly subscription model. The base fee is 19,90 EUR per month. This includes up to 100 concurrent users. Additional users are charged with 0,29 EUR per user and month. You can set a limit to make sure you don’t exceed your budget, however in this case, users might be able to connect if the peak user limit is reached. You can use as many rooms as you like, there is no limit.

Example

You have a game with 1000 concurrent users. You want to use ODIN for voice chat. You want to make sure that you don’t exceed a monthly budget of 500 EUR. You set the peak user limit to 1000. You will be charged 19,90 EUR for the base fee and 290 EUR for the additional users. In total, you will be charged 309,90 EUR for the month.

On-premise

Our on-premise solution is based on the number of server instances you want to run. The base fee is 350 EUR per month and includes one instance. Every instance is capable of handling up to 1000 concurrent users. If you need more users, you have two options:

You can add additional instances for 350 EUR per month each (horizontally scaling)
You can upgrade your instance to a higher tier (vertically scaling)

Horizontal Scaling

If you need more than 1000 concurrent users, you can add additional instances. If your application does not require more than 1000 concurrent users in one room that is the best option. You can start as many instances as you like with your license, we keep track of everything and charge you accordingly. We charge the average number of peak instances per day.

Example

You have a match-based 5on5 game and expect 5000 concurrent users (i.e. 500 matches simultaneously). You want to use ODIN for voice chat. That means, every room will have a maximum of 10 concurrent users, therefore it’s easy to scale horizontally and would require 5 instances. You will be charged 1750 EUR per month.

However, if you have an event that peaks your user numbers to 10000 concurrent users you could just launch 5 additional instances when the event starts and stop them once the event is over - let’s say the event lasts for 3 days, that would mean, that you have 27 days with 5 instances and 3 days with 10 instances. In total, you will be charged 275 + 310 * (350 EUR / 30) = 2007 EUR.

This shows, that it makes sense to implement some sort of auto scaling on your side if you have volatile user numbers. We don’t provide a solution but there are numerous solutions available like Kubernetes.

If you don’t want to have that hassle, you can just switch to our cloud-hosting solution that is capable of handling all that scaling for you.

Vertical Scaling

If you need more than 1000 concurrent users in one room, you can upgrade your instance to a higher tier. We offer blocks of 1000 concurrent users. The base fee is 350 EUR per month and includes one block. Every block is capable of handling up to 1000 concurrent users and costs additional 350 EUR per month. We don’t have a limit on how many blocks you can add, but at some point it will bottleneck on the hardware (either CPU, RAM or network). As this is highly dependent on the use case, we can’t provide a general recommendation but consider a load test to find out - we will be there to help you with that.

Example

You have a metaverse application and want to bring 5000 concurrent users into one room. That is possible as ODIN provides a technology of spatial clipping. What that means is, that you regularly send the position of users in 3D space to ODIN and ODIN will only send the audio of users that are in a certain range to the user.

As you have 5000 concurrent users in one room, you need 5 blocks. You will be charged 1750 EUR per month. Let’s say, you want to open another instance of your metaverse, in this case you can combine horizontal and vertical scaling and you just add another instance with 5 blocks. You will be charged 3500 EUR per month.

`}),e.add({id:3634,href:"https://www.4players.io/odin/faq/general/is-odin-as-good-as-discord/",title:"Is ODIN as good as Discord?",section:"ODIN Documentation",description:"Discover how ODIN compares to Discord in voice quality and latency, and learn how it enables you to create your own voice chat applications with superior performance.",content:`

ODIN is a voice chat SDK that you can integrate into your game or app. It is not a standalone application like Discord. However, in terms of voice quality and latency many of our customers report that ODIN is much better than Discord. You can also use ODIN to build your own Discord-like application.

`}),e.add({id:3635,href:"https://www.4players.io/odin/faq/general/does-odin-also-provide-text-message-chat/",title:"Does ODIN also provide text message chat?",section:"ODIN Documentation",description:"Explore ODIN's text messaging capabilities, allowing you to send text, data, and even binary content like images or videos, with our versatile SDKs.",content:`

Yes, ODIN provides a text message chat. You can use it to send text messages to other users in the same room. All our SDKs provide a simple interface to send and receive text and other form of data. ODIN is very flexible here and let’s you send any kind of data you want. You can even send binary data like images or videos.

Look out for the SendMessage and OnMessageReceived methods in our SDKs.

`}),e.add({id:3637,href:"https://www.4players.io/4netplayers/contact/",title:"Contact us",section:"Free Server Hosting",description:"Get technical support for anything related to 4Netplayers",content:`

Support / Onboarding

Join our official Discord server to chat with the 4Netplayers operations team to onboard your game into our library. You can also chat directly with our sales team.

Sales

Please fill out this form and we’ll come back to you as soon as possible:

Contact Sales Team
or join our Discord server and chat with the sales team directly

`}),e.add({id:3641,href:"https://www.4players.io/company/media_press/",title:"Media & PR",section:"Companies",description:"Download logos and contact our PR team",content:`

Media Contact

Thank you very much in your interest in our company and our products. On this page you’ll find our current logos, claims and other resources that you can use to present our products or company.

You can download a zip file containing all these assets here: 4players_media_assets.zip (57,5MB).

About 4Players

Short version

4Players creates metaverse-ready, cross-platform, safe and interactive experiences with its voice chat tool, with 3D spatial audio and a global server network. Size really doesn’t matter: 4Players’ services fit all demands and budgets.

Real-time communication is essential for a fun, immersive gaming experience and player retention. This is why 4Players’ mission is to create powerful tools for integrated voice and video chat that make games more immersive, social and interactive.

About 4Players

Longer version

4Players has been propelling and co-shaping the evolution of gaming for more than 20 years, today the team create metaverse-ready, cross-platform, safe and interactive experiences with voice chat tools, 3D spatial audio and a global server network. Size really doesn’t matter: its services fit all demands and budgets, providing cutting-edge services for game developers looking to bring their products into the new era of gaming.

On a mission to create an immersive gaming experience, the 4Players team has ensured its products are the go-to for this generation. Tailored to both developers and consumers, 4Players’ wealth of products offers tools for anyone looking to level up their gaming and communication experience. From development audio tools and free game server hosting for developers, to voice chat and game server hosting for players, 4Players provides a next-generation experience for all.

4Players is the future of immersive audio in multiplayer games, designed by seasoned professionals with a thorough understanding of how games should interact with players. Offering an SDK that is seamless and easy to use for developers, 4Players is a true pioneer of next-generation gaming, and it’s only a few clicks away.

4Players Logos

Please find below the logos for our company 4Players GmbH.

Transparent logo for light environments

Transparent logo for dark environments

Transparent icon for light environments

Transparent icon for dark environments

ODIN Logos

Please find below the logos for our ODIN product.

Transparent logo for light environments

Transparent logo for dark environments

Transparent vertical logo for light environments

Transparent vertical logo for dark environments

ODIN logo on background

4Netplayers Logos

Please find below the logos for 4Netplayers

Transparent logo for light environments

Transparent logo for dark environments

Transparent logo for light environments

Transparent logo for dark environments

Wallpaper/Backgrounds

Use these images as a desktop wallpaper or as a background for your ODIN assets.

ODIN background image or wallpaper

Viking background image or wallpaper

Headset background image or wallpaper

`}),e.add({id:3642,href:"https://www.4players.io/company/privacy/",title:"Privacy Policy",section:"Companies",description:"Privacy Policy of 4Players GmbH",content:`

Privacy Policy

1. An overview of data protection
2. General information and mandatory information
3. Data protection officer
4. Data collection on our website or app
5. Social media
6. Analytics and advertising
7. Newsletter
8. Plugins and Tools
9. Contract conclusion
10. A.I. Services

1. An overview of data protection

General

The following gives a simple overview of what happens to your personal information when you visit our website. Personal information is any data with which you could be personally identified. Detailed information on the subject of data protection can be found in our privacy policy found below.

Data collection on our website

Who is responsible for the data collection on this website?

The data collected on this website are processed by the website operator. The operator’s contact details can be found in the website’s required legal notice.

How do we collect your data?

Some data are collected when you provide it to us. This could, for example, be data you enter on a contact form.

Other data are collected automatically by our IT systems when you visit the website. this data are primarily technical data such as the browser and operating system you are using or when you accessed the page. this data are collected automatically as soon as you enter our website.

What do we use your data for?

Part of the data is collected to ensure the proper functioning of the website. Other data can be used to analyze how visitors use the site.

What rights do you have regarding your data?

You always have the right to request information about your stored data, its origin, its recipients, and the purpose of its collection at no charge. You also have the right to request that it be corrected, blocked, or deleted. You can contact us at any time using the address given in the legal notice if you have further questions about the issue of privacy and data protection. You may also, of course, file a complaint with the appropriate regulatory authorities.

Analytics and third-party tools

When visiting our website, statistical analyses may be made of your surfing behavior. This happens primarily using cookies and analytics. The analysis of your surfing behavior is usually anonymous, i.e. we will not be able to identify you from this data. You can object to this analysis or prevent it by not using certain tools. Detailed information can be found in the following privacy policy.

You can object to this analysis. We will inform you below about how to exercise your options in this regard.

2. General information and mandatory information

Data protection

The operators of this website take the protection of your personal data very seriously. We treat your personal data as confidential and in accordance with the statutory data protection regulations and this privacy policy.

If you use this website, various pieces of personal data will be collected. Personal information is any data with which you could be personally identified. This privacy policy explains what information we collect and what we use it for. It also explains how and for what purpose this happens.

Please note that data transmitted via the internet (e.g. via email communication) may be subject to security breaches. Complete protection of your data from third-party access is not possible.

Notice concerning the party responsible for this website

The party responsible for processing data on this website is:

4Players GmbH Deelbögenkamp 4 22297 Hamburg Management board: Phillip Schuster, Rainer Rosenbusch, Oliver Paul

Telephone: +49 (40) 607742610
Email: support@4netplayers.com

The responsible party is the natural or legal person who alone or jointly with others decides on the purposes and means of processing personal data (names, email addresses, etc.).

Many data processing operations are only possible with your express consent. You may revoke your consent at any time with future effect. An informal email making this request is sufficient. The data processed before we receive your request may still be legally processed.

Right to file complaints with regulatory authorities

If there has been a breach of data protection legislation, the person affected may file a complaint with the appropriate regulatory authorities. The appropriate regulatory authority for matters related to data protection legislation is the data protection officer of the German state in which our company is headquartered. A list of data protection officers and their contact details can be found at the following link: https://www.bfdi.bund.de/DE/Infothek/Anschriften_Links/anschriften_links-node.html .

Right to data portability

You have the right to have data which we process based on your consent or in fulfillment of a contract automatically delivered to yourself or to a third party in a standard, machine-readable format. If you require the direct transfer of data to another responsible party, this will only be done to the extent technically feasible.

SSL or TLS encryption

This site uses SSL or TLS encryption for security reasons and for the protection of the transmission of confidential content, such as the inquiries you send to us as the site operator. You can recognize an encrypted connection in your browser’s address line when it changes from “http://” to “https://” and the lock icon is displayed in your browser’s address bar.

If SSL or TLS encryption is activated, the data you transfer to us cannot be read by third parties.

Encrypted payments on this website

If you enter into a contract which requires you to send us your payment information (e.g. account number for direct debits), we will require this data to process your payment.

Payment transactions using common means of payment (Visa/MasterCard, direct debit) are only made via encrypted SSL or TLS connections. You can recognize an encrypted connection in your browser’s address line when it changes from “http://” to “https://” and the lock icon in your browser line is visible.

In the case of encrypted communication, any payment details you submit to us cannot be read by third parties.

Information, blocking, deletion

As permitted by law, you have the right to be provided at any time with information free of charge about any of your personal data that is stored as well as its origin, the recipient and the purpose for which it has been processed. You also have the right to have this data corrected, blocked or deleted. You can contact us at any time using the address given in our legal notice if you have further questions on the topic of personal data.

Opposition to promotional emails

We hereby explicitly prohibit the use of contact data published in the context of website legal notice requirements with regard to sending promotional and informational materials not explicitly requested. The website operator reserves the right to take specific legal action if unsolicited advertising material, such as email spam, is received.

3. Data protection officer

Statutory data protection officer

We have appointed a data protection officer for our company.

4Players GmbH
Der Datenschutzbeauftragte
Deelbögenkamp 4c
22297 Hamburg

Email: datenschutz@4players.de

4. Data collection on our website or app

Cookies

Some of our web pages use cookies. Cookies do not harm your computer and do not contain any viruses. Cookies help make our website more user-friendly, efficient, and secure. Cookies are small text files that are stored on your computer and saved by your browser.

Most of the cookies we use are so-called “session cookies.” They are automatically deleted after your visit. Other cookies remain in your device’s memory until you delete them. These cookies make it possible to recognize your browser when you next visit the site.

You can configure your browser to inform you about the use of cookies so that you can decide on a case-by-case basis whether to accept or reject a cookie. Alternatively, your browser can be configured to automatically accept cookies under certain conditions or to always reject them, or to automatically delete cookies when closing your browser. Disabling cookies may limit the functionality of this website.

Cookies which are necessary to allow electronic communications or to provide certain functions you wish to use (such as the shopping cart) are stored pursuant to Art. 6 paragraph 1, letter f of GDPR. The website operator has a legitimate interest in the storage of cookies to ensure an optimized service provided free of technical errors. If other cookies ( such as those used to analyze your surfing behavior) are also stored, they will be treated separately in this privacy policy.

Web server log files

The website provider automatically collects and stores information that your browser automatically transmits to us in “server log files”. These are:

Browser type and browser version
Operating system used
Referrer URL
Host name of the accessing computer
Time of the server request
IP address

This data will not be combined with data from other sources.

This data will be deleted after 90 days.

The basis for data processing is Art. 6 para. 1 lit. f GDPR, which allows the processing of data to fulfill a contract or for measures preliminary to a contract.

Gameserver log files

The game server writes log files. Depending on the game, the log files may contain the following personal data, among others:

IP address
Nickname
Game-specific IDs
Chat history

4Players saves the log files for the server owner.

This data is not combined with data from other sources.

The data is deleted after 7 days.

Data processing is based on Art. 6 para. 1 lit. (f) of the GDPR, which permits the processing of data for the execution of a contract or pre-contractual measures.

Teamspeak 3 server log files

The Teamspeak 3 server does not store server log files (server log) because this function has been disabled by 4Players.

The operator (server admin) of a 4Players’ Teamspeak 3 server can obtain information about the following personal data of a particular visitor:

IP address
Nickname
Teamspeak 3 specific ID
Date of account creation
Last account login
Number of logins

Some personal data is necessary for the operation and administration of the server, e.g. to remove or permanently block certain visitors. Neither the server operator nor the host (4Players) has any influence on the functioning of the client and any external tools. Detailed information about the client’s data protection can be found at teamspeak.com/en/privacy-and-terms/

This data is not combined with data from other sources.

Registration on this website

You can register on our website in order to access additional functions offered here. The input data will only be used for the purpose of using the respective site or service for which you have registered. The mandatory information requested during registration must be provided in full. Otherwise, we will reject your registration.

To inform you about important changes such as those within the scope of our site or technical changes, we will use the email address specified during registration.

We will process the data provided during registration only based on your consent per Art. 6 (1)(a) GDPR. You may revoke your consent at any time with future effect. An informal email making this request is sufficient. The data processed before we receive your request may still be legally processed.

We will continue to store the data collected during registration for as long as you remain registered on our website or will be deleted after 26 months of inactivity. Statutory retention periods remain unaffected.

Registration with Facebook Connect

Instead of registering directly on our website, you may also register using Facebook Connect. This service is provided by Facebook Ireland Limited, 4 Grand Canal Square, Dublin 2, Ireland.

If you decide to register with Facebook Connect and click on the “Login with Facebook” or “Connect with Facebook” buttons, you will be automatically redirected to the Facebook platform. There you can log in with your Facebook username and password. This will link your Facebook profile to our website or services. This link gives us access to your data stored on Facebook. Including especially your:

Facebook name
Email address provided to Facebook
Facebook ID

This data will be used to set up, provide, and personalize your account.

For more information, see Facebook’s Terms of Use and Privacy Policy. These can be found at https://de-de.facebook.com/about/privacy/ and https://www.facebook.com/legal/terms/.

Leaving comments on this website

If you use the comment function on *.4pforen.4players.de, the time at which you created the comment and your email address will be stored along with your comment, as well as your username.

Storage of the IP address

Our comment function stores the IP addresses of those users who post comments. Since we do not check comments on our site before they go live, we need this information to be able to pursue action for illegal or slanderous content.

Subscribing to the comment feed

As a user of this site, you can sign up to receive the comment feed after registering. Your email address will be checked with a confirmation email. You can unsubscribe from this function at any time by clicking the link in the emails. The data provided when you subscribed to the comments feed will then be deleted, but if you have submitted this data to us for other purposes or elsewhere (such as subscribing to a newsletter), it will be retained.

How long comments are stored

The comments and the associated data (e.g. IP address) are stored and remain on our website until the content commented upon has been completely deleted or the comments are required to be removed for legal reasons (slander, etc.).

Legal basis

The comments are stored based on your consent per Art. 6 (1) (a) GDPR. You may revoke your consent at any time with future effect. An informal email making this request is sufficient. The data processed before we receive your request may still be legally processed.

Processing of data (customer and contract data)

We collect, process, and use personal data only insofar as it is necessary to establish, or modify legal relationships with us (master data). This is done based on Art. 6 (1) (b) GDPR, which allows the processing of data to fulfill a contract or for measures preliminary to a contract. We collect, process and use your personal data when accessing our website (usage data) only to the extent required to enable you to access our service or to bill you for the same.

Collected customer data shall be deleted after completion of the order or termination of the business relationship. Legal retention periods remain unaffected.

Data transferred when signing up for services and digital content

We transmit personally identifiable data to third parties only to the extent required to fulfill the terms of your contract with us, for example, to banks entrusted to process your payments.

Your data will not be transmitted for any other purpose unless you have given your express permission to do so. Your data will not be disclosed to third parties for advertising purposes without your express consent.

The basis for data processing is Art. 6 (1) (b) GDPR, which allows the processing of data to fulfill a contract or for measures preliminary to a contract.

The content on our pages can be shared on other social networks like Facebook, Twitter, or Google+, but not limited to the aforementioned. This page uses our own tool for this function. This tool establishes direct contact between the networks and users only after users click on one of these buttons.

This tool does not automatically transfer user data to the operators of these platforms. If users are logged into one or more of the social networks, the Like, +1, and Share buttons will display an information window in which the user can edit the text before it is sent.

Our users can share the content of this page on social networks without their providers creating profiles of users’ surfing behavior.

Our website includes plugins for the social network Facebook, Facebook Inc., 1 Hacker Way, Menlo Park, California 94025, USA. The Facebook plugins can be recognized by the Facebook logo or the Like button on our site. For an overview of Facebook plugins, see https://developers.facebook.com/docs/plugins/.

When you visit our site, a direct connection between your browser and the Facebook server is established via the plugin. This enables Facebook to receive information that you have visited our site from your IP address. If you click on the Facebook “Like button” while you are logged into your Facebook account, you can link the content of our site to your Facebook profile. This allows Facebook to associate visits to our site with your user account. Please note that, as the operator of this site, we have no knowledge of the content of the data transmitted to Facebook or of how Facebook uses this data. For more information, please see Facebook’s privacy policy at https://de-de.facebook.com/policy.php.

If you do not want Facebook to associate your visit to our site with your Facebook account, please log out of your Facebook account.

Retargeting

The 4Players websites use retargeting technologies such as Pixel from Facebook Ireland Limited. We use this technology to make our online presence more interesting for you. This technology enables users of the Internet who are already interested in 4Players to be targeted with advertising on websites of our partners. We are confident that a mix of a personalised, interest-based advertising is generally more interesting for users of the Internet than advertising which has no such personal basis. This advertising is incorporated into the websites of our partners on the basis of cookie technology and an analysis of previous usage behaviour. This form of advertising is completely anonymous. No personal data is stored and no usage profile will be associated with your personal data.

When you visit one of the pages of our website and have set your browser settings to accept cookies, for us this means that you want to use our products and services and you agree to the use of cookies and other technology as described in our Privacy Policy.

Twitter plugin

Functions of the Twitter service have been integrated into our website and app. These features are offered by Twitter Inc., 1355 Market Street, Suite 900, San Francisco, CA 94103, USA. When you use Twitter and the “Retweet” function, the websites you visit are connected to your Twitter account and made known to other users. In doing so, data will also be transferred to Twitter. We would like to point out that, as the provider of these pages, we have no knowledge of the content of the data transmitted or how it will be used by Twitter. For more information on Twitter’s privacy policy, please go to https://twitter.com/privacy.

Your privacy preferences with Twitter can be modified in your account settings at https://twitter.com/account/settings.

Google+ plugin

Our pages use Google+ functions. It is operated by Google Inc., 1600 Amphitheatre Parkway, Mountain View, CA 94043, USA.

Collection and disclosure of information: Using the Google +1 button allows you to publish information worldwide. By means of the Google+ button, you and other users can receive custom content from Google and our partners. Google stores both the fact that you have +1’d a piece of content and information about the page you were viewing when you clicked +1. Your +1 can be displayed together with your profile name and photo in Google services, for example in search results or in your Google profile, or in other places on websites and advertisements on the Internet.

Google records information about your +1 activities to improve Google services for you and others. To use the Google + button, you need a globally visible, public Google profile that must contain at least the name chosen for the profile. This name is used by all Google services. In some cases, this name may also replace a different name that you have used to share content via your Google account. The identity of your Google profile can be shown to users who know your email address or other information that can identify you.

Use of collected data: In addition to the uses mentioned above, the information you provide is used in accordance with the applicable Google data protection policies. Google may publish summary statistics about users’ +1 activity or share it with users and partners, such as publishers, advertisers, or affiliate websites.

6. Analytics and advertising

Google Analytics

This website uses Google Analytics, a web analytics service. It is operated by Google Inc., 1600 Amphitheatre Parkway, Mountain View, CA 94043, USA.

Google Analytics uses so-called “cookies”. These are text files that are stored on your computer and that allow an analysis of the use of the website by you. The information generated by the cookie about your use of this website is usually transmitted to a Google server in the USA and stored there.

this data will be deleted after 26 months of inactivity

Google Analytics cookies are stored based on Art. 6 (1) (f) GDPR. The website operator has a legitimate interest in analyzing user behavior to optimize both its website and its advertising.

IP anonymization

We have activated the IP anonymization feature on this website. Your IP address will be shortened by Google within the European Union or other parties to the Agreement on the European Economic Area prior to transmission to the United States. Only in exceptional cases is the full IP address sent to a Google server in the US and shortened there. Google will use this information on behalf of the operator of this website to evaluate your use of the website, to compile reports on website activity, and to provide other services regarding website activity and Internet usage for the website operator. The IP address transmitted by your browser as part of Google Analytics will not be merged with any other data held by Google.

Browser plugin

You can prevent these cookies being stored by selecting the appropriate settings in your browser. However, we wish to point out that doing so may mean you will not be able to enjoy the full functionality of this website. You can also prevent the data generated by cookies about your use of the website (incl. your IP address) from being passed to Google, and the processing of this data by Google, by downloading and installing the browser plugin available at the following link: https://tools.google.com/dlpage/gaoptout?hl=en.

Objecting to the collection of data

You can prevent the collection of your data by Google Analytics by clicking on the following link. An opt-out cookie will be set to prevent your data from being collected on future visits to this site: Disable Google Analytics.

For more information about how Google Analytics handles user data, see Google’s privacy policy: https://support.google.com/analytics/answer/6004245?hl=en .

Matomo (formerly Piwik)

This website or app uses the open source web analytics service Matomo. Matomo uses so-called “cookies”. These are text files that are stored on your computer and that allow an analysis of the use of the website by you. For this purpose, the information generated by the cookie about the use of this website is stored on our server. The IP address is anonymized before it is stored.

Matomo cookies remain on your device until you delete them.

The storage of Matomo cookies is based on Art. 6 (1) (f) GDPR. The website operator has a legitimate interest in analyzing user behavior in order to optimize both its website and its advertising.

The information generated by the cookies about your use of this website will not be disclosed to third parties. You can prevent these cookies being stored by selecting the appropriate settings in your browser. However, we wish to point out that doing so may mean you will not be able to enjoy the full functionality of this website.

If you do not agree with the storage and use of your data, you can disable this feature here: Opt-Out . In this case, an opt-out cookie will be stored in your browser to prevent Matomo from storing your usage data. If you delete your cookies, this will mean that the opt-out cookie will also be deleted. You will then need to reactivate it when you return to our site if you wish your activity not to be tracked.

AWStats

We use “AWStats” statistical software on our website to analyze user behavior. “AWStats” statistical software creates cookies that are stored as small text files on your device at the end of your visit to our website. The cookies are created via the “4players.de” domain. The name of the cookies begins with “AW.” The cookies are stored on your device for a maximum of 50 days and enable us recognize users who have already been on our website. They also enable us to perform a non-personal analysis of user behavior on our website. For example, we can see which page you came from to this website and which pages you have viewed on our website and for how long. The cookies are used for the purpose of creating pseudonymized user profiles. If you want to prevent your user behavior from being analyzed, you can use your browser settings to block the “4players.de” domain from creating cookies on your device. Please note, however, that blocking cookies will limit your use of our service.

This website uses Google AdSense, a service for including advertisements from Google Inc. (“Google”). It is operated by Google Inc., 1600 Amphitheatre Parkway, Mountain View, CA 94043, USA.

Google AdSense uses so-called “cookies”, which are text files stored in your computer that enable an analysis of the way you use the website. Google AdSense also uses so-called web beacons (invisible graphics). Through these web beacons, information such as the visitor traffic on these pages can be evaluated.

The information generated by cookies and web beacons relating to your use of this website (including your IP address), and delivery of advertising formats, is transmitted to a Google server in the US and stored there. This information can be passed on from Google to contracting parties of Google. However, Google will not merge your IP address with other data you have stored.

AdSense cookies are stored based on Art. 6 (1) (f) GDPR. The website operator has a legitimate interest in analyzing user behavior to optimize both its website and its advertising.

You can prevent the installation of cookies by setting your browser software accordingly. Please be aware that in this case, you may not be able to make full use of all the features of this website. By using this website, you agree to the processing of data relating to you and collected by Google as described and for the purposes set out above.

Google AdMob

Our apps use Google AdMob, a service for including advertisements from Google Inc. (“Google”). It is operated by Google Inc., 1600 Amphitheatre Parkway, Mountain View, CA 94043, USA.

Google AdMob collects information from your mobile device.

The information relating to your use of our apps (including your IP address), and delivery of advertising formats, is transmitted to a Google server in the US and stored there. This information can be passed on from Google to contracting parties of Google. However, Google will not merge your IP address with other data you have stored.

The data collected by AdMob is stored based on Art. 6 (1) (f) GDPR. The app operator has a legitimate interest in analyzing user behavior to optimize both its app and its advertising.

By using this app, you agree to the processing of data relating to you and collected by Google as described and for the purposes set out above.

Google AdWords and Google Conversion Tracking

This website uses Google AdWords. AdWords is an online advertising program from Google Inc., 1600 Amphitheater Parkway, Mountain View, CA 94043, United States (“Google”).

As part of Google AdWords, we use so-called conversion tracking. When you click on an ad served by Google, a conversion tracking cookie is set. Cookies are small text files that your internet browser stores on your computer. These cookies expire after 30 days and are not used for personal identification of the user. Should the user visit certain pages of the website and the cookie has not yet expired, Google and the website can tell that the user clicked on the ad and proceeded to that page.

Each Google AdWords advertiser has a different cookie. Thus, cookies cannot be tracked using the website of an AdWords advertiser. The information obtained using the conversion cookie is used to create conversion statistics for the AdWords advertisers who have opted for conversion tracking. Customers are told the total number of users who clicked on their ad and were redirected to a conversion tracking tag page. However, advertisers do not obtain any information that can be used to personally identify users. If you do not want to participate in tracking, you can opt-out of this by easily disabling the Google Conversion Tracking cookie by changing your browser settings. In doing so, you will not be included in the conversion tracking statistics.

Conversion cookies are stored based on Art. 6 (1) (f) GDPR. The website operator has a legitimate interest in analyzing user behavior to optimize both its website and its advertising.

For more information about Google AdWords and Google Conversion Tracking, see the Google Privacy Policy: https://www.google.de/policies/privacy/.

Affiliate partners

This website uses tracking cookies from the following affiliate partners:

belboon GmbH, Weinmeisterstr. 12-14, 10178 Berlin – Data protection notice
AWIN AG, Eichhornstraße 3, 10785 Berlin – Data protection notice
ADCELL / Firstlead GmbH mit der Marke ADCELL (www.adcell.de) – Data protection notice

Cookies are created when a visitor clicks on an advertisement for our products and services which contains an affiliate partner’s link. Our affiliate partners use cookies to track the origin of orders. Our affiliate partners also use so-called tracking pixels to evaluate information on the web pages, such as visitor traffic. The information generated by cookies and tracking pixels about the use of this website (including IP addresses) and the delivery of advertising formats is transferred to our affiliate partners’ servers and stored there. Among other things, they can see that a partner link has been clicked on this website. The affiliate partners can pass this (anonymized) information on to contractual partners under certain circumstances, but data, such as IP addresses, is not merged with other stored data.

If you would like to receive our newsletter, we require a valid email address as well as information that allows us to verify that you are the owner of the specified email address and that you agree to receive this newsletter. No additional data is collected or is only collected on a voluntary basis. We only use this data to send the requested information and do not pass it on to third parties.

We will, therefore, process any data you enter onto the contact form only with your consent per Art. 6 (1) (a) GDPR. You can revoke consent to the storage of your data and email address as well as their use for sending the newsletter at any time, e.g. through the “unsubscribe” link in the newsletter. The data processed before we receive your request may still be legally processed.

The data provided when registering for the newsletter will be used to distribute the newsletter until you cancel your subscription when said data will be deleted. Data we have stored for other purposes (e.g. email addresses for the members area) remain unaffected.

Mailjet

This website uses Mailjet for sending newsletters. The provider is Mailjet GmbH, Rankestr. 21, 10789 Berlin, Germany. Mailjet is a service to organize and analyze the sending of newsletters. The data you enter to subscribe to the newsletter (e.g. e-mail address) is stored on the servers of Mailjet.

Our newsletters sent with Mailjet enable us to analyse the behaviour of the newsletter recipients. Among other things, it is possible to analyse how many recipients have opened the newsletter message and how often which link in the newsletter was clicked on. Conversion tracking can also be used to analyse whether a pre-defined action (e.g. purchase of a product on our website) was carried out after clicking on the link in the newsletter. Further information on data analysis by Mailjet newsletter is available at www.mailjet.com/feature/tracking-tools

The data processing is carried out on the basis of your consent (Art. 6 (1) (a) GRDPR). You can revoke this consent at any time by cancelling the newsletter. The legality of the data processing operations already carried out remains unaffected by the revocation.

If you do not want to receive any analysis from Mailjet, you will have to unsubscribe from the newsletter. For this purpose, we provide a corresponding link in every newsletter message. You can also unsubscribe directly on the website. Data that has been saved by us for other purposes (e.g. e-mail addresses for the member area) remains unaffected by this.

You can find more details in the data protection regulations of Mailjet under: www.mailjet.com/privacy-policy.

8. Plugins and tools

YouTube

Our website uses plugins from YouTube, which is operated by Google. The operator of the pages is YouTube LLC, 901 Cherry Ave., San Bruno, CA 94066, USA.

If you visit one of our pages featuring a YouTube plugin, a connection to the YouTube servers is established. Here the YouTube server is informed about which of our pages you have visited.

If you’re logged in to your YouTube account, YouTube allows you to associate your browsing behavior directly with your personal profile. You can prevent this by logging out of your YouTube account.

YouTube is used to help make our website appealing. This constitutes a justified interest pursuant to Art. 6 (1) (f) GDPR.

Further information about handling user data, can be found in the data protection declaration of YouTube under https://www.google.de/intl/de/policies/privacy.

Google Web Fonts

For uniform representation of fonts, this page uses web fonts provided by Google. When you open a page, your browser loads the required web fonts into your browser cache to display texts and fonts correctly.

For this purpose your browser has to establish a direct connection to Google servers. Google thus becomes aware that our web page was accessed via your IP address. The use of Google Web fonts is done in the interest of a uniform and attractive presentation of our website. This constitutes a justified interest pursuant to Art. 6 (1) (f) GDPR.

If your browser does not support web fonts, a standard font is used by your computer.

Further information about handling user data, can be found at https://developers.google.com/fonts/faq and in Google’s privacy policy at https://www.google.com/policies/privacy/.

Google reCAPTCHA

We use “Google reCAPTCHA” (hereinafter “reCAPTCHA”) on our websites. This service is provided by Google Inc., 1600 Amphitheater Parkway, Mountain View, CA 94043, USA (“Google”).

reCAPTCHA is used to check whether the data entered on our website (such as on a contact form) has been entered by a human or by an automated program. To do this, reCAPTCHA analyzes the behavior of the website visitor based on various characteristics. This analysis starts automatically as soon as the website visitor enters the website. For the analysis, reCAPTCHA evaluates various information (e.g. IP address, how long the visitor has been on the website, or mouse movements made by the user). The data collected during the analysis will be forwarded to Google.

The reCAPTCHA analyses take place completely in the background. Website visitors are not advised that such an analysis is taking place.

Data processing is based on Art. 6 (1) (f) GDPR. The website operator has a legitimate interest in protecting its site from abusive automated crawling and spam.

For more information about Google reCAPTCHA and Google’s privacy policy, please visit the following links: https://www.google.com/intl/de/policies/privacy/ and https://www.google.com/recaptcha/intro/android.html .

Trustpilot

Since your opinion is important to us and we would like to know where we can improve our offers, customer reviews are particularly important to us. Therefore we offer you the possibility to rate our offers via the portal www.trustpilot.de of the company Trustpilot A/S, Pilestraede 58, 5th floor, 1112 Copenhagen, Denmark. For this purpose, you will receive an e-mail from us after conclusion of a contract in which we ask for your consent to an invitation from Trustpilot to an evaluation. If you accept this invitation, we will provide Trustpilot with your email address, first name and last name for this purpose. If you participate in this rating system, your rating will be published on our website as well as on the Trustpilot and its partners’ websites. Further information on data protection at Trustpilot can be found at https://de.legal.trustpilot.com/end-user-privacy-terms

9. Contract conclusion

Payment service providers, postal items, debt collection

Global Collect

Our website offers payments via our service providers Global Collect Services B.V., Planetenweg 43-59, 2132 HM Hoofdorp, Netherlands (hereinafter referred to as “Global Collect”).

When you pay for a product or service, the payment information you enter is sent to Global Collect. Further information can be obtained here: Contact and Privacy Policy

The payment data you provide will be supplied to Global Collect based on Art. 6(1)(a) (Consent) and Art. 6(1)(b) GDPR ( Processing for the performance of a contract). You have the option to revoke your consent at any time. Revocation does not affect the processing of data previously collected.

onlinebrief24.de

We use the onlinebrief24.de service of letterei.de Postdienste GmbH, Frankfurter Str. 74, 64521 Groß-Gerau, Germany, to print, process and deliver personalised mail.

The data protection regulations for this service can be viewed here: Privacy Policy

The transmission of your data to onlinebrief24.de takes place on the basis of Art. 6(1)(b) GDPR (Processing for the performance of a contract).

REAL Solution Inkasso

If you do not pay outstanding invoices despite repeated reminders, we are entitled to transfer the data required to collect a debt to a debt collection service provider in order to collect the debt on our behalf. Alternatively, we may sell outstanding receivables to a debt collection service provider. The latter then becomes the owner of the claim and asserts the claims in his own name. We cooperate with the following debt collection service provider: REAL Solution Inkasso GmbH & Co. KG, Normannenweg 32, 20537 Hamburg, Germany.

The data protection regulations for this service provider can be viewed here: Privacy Policy

The lawful basis for the transmission of data in connection with the collection of a debt is Art. 6(1)(b) GDPR. The transmission of data in connection with the sale of receivables is based on Art. 6(1)(f) GDPR.

10. A.I. Services

A.I. Assistant

Our experimental A.I. assistant app is using the Assistants API from OpenAI, L.L.C., 3180 18th St., San Francisco, California 94110.

To use the assistant and to be able to help you with acceptable answers, you have to consent into recording your input and questions for the sole purpose of improving the quality of the output and preventing misinformation or factual errors. Your questions and the assistant’s answers will both be anonymized and sent to OpenAI.

`}),e.add({id:3643,href:"https://www.4players.io/odin/support/",title:"Support",section:"ODIN Documentation",description:"Get technical support for anything related 4Players ODIN",content:`

Premium Support

Please understand, that we are not able to provide 24/7 support and that you might not get an answer immediately. If you need urgent help or assistant from our developers we offer premium support services. Please contact our sales team to learn more about our premium support services and pricing.

Book a meeting

AI Assistant

The AI assistant is available 24/7 to answer your questions. We have spent a lot of time to train the AI assistants with our SDKs, guides and FAQs that we have collected over the years. And we are using latest AI technology provided by OpenAI to do our best to ensure, that the assistants are helpful. But we are still in the early stages of this technology, and we are constantly improving the assistants. So please be patient with us and help us to improve the assistants by providing feedback (directly within the app with thumbs up and down) and in Discord if you like.

Try ODIN AI Assistant

Discord

Join our official Discord server to chat with us directly and become a part of the 4Players ODIN community.

Twitter

Have a quick question? Tweet us at @4PlayersBiz and we’ll help you resolve any issues.

Email

Don’t use Discord or Twitter? Send an email to odin@4players.io and we’ll get back to you as soon as possible.

`}),e.add({id:3645,href:"https://www.4players.io/odin/introduction/web-client/",title:"Web Client",section:"ODIN Documentation",description:"This guide shows you how to leverage our Web Client to test your ODIN integration",content:`

We provide a free web client that you can use to test your ODIN integration. It’s a simple yet powerful web app built on top of our Web SDK that we use internally to test our SDKs. It allows you to connect to any ODIN room and communicate with others. As ODIN is fully cross platform, you can also use the Web SDK to test your Unreal or Unity integration.

Prerequisites

An ODIN access key. Read this guide to learn how to generate an access key.
A modern browser like Chrome, Firefox or Safari.
A microphone (optional)
A pair of headphones or speakers

Data structures used

ODIN gives you full flexibility with its user data structure. You can use it to store any data you want on each peer. The Web Client uses this structure to show the users name, the version of the client and the platform it is running on. It’s a JSON object, i.e. you need to encode a JSON Object to a byte array and set that as the user data. Please note: This is fully optional - it’s just “eye candy”. The Web Client will show any peer connected to the room - if no user data in this form has been provided it will just title it “Unknown User”.

export interface Avatar {
  data: string,
  seed: string
}

export interface UserData {
  name: string,
  avatar: Avatar,
  userId: string,
  outputMuted: number,
  inputMuted: number,
  platform: string,
  version: string
}

Using the Web Client

The Web Client is available at https://app.odin.4players.io/. When launching the app, you’ll see a screen like this:

Setting your Access Key

The first thing you need to do is to set your access key. You can do this by clicking on the small gear icon next to the connect button - that is important as you want to use the same access key you use for your app, game or website. If access keys don’t match users will not be able to communicate with each other.

Info

Depending on your screen size you might need to scroll down that dialog window a bit, as the access key settings are at the bottom of the dialog. Also note, that you enter your Access Key into the field Access Key (not Access Token).

Joining a room

Enter the room and the same gateway as you use in your app, game or website. You can also enter a name. The web client will fill out the data structure for user data described above. If your integration insists on a specific user data you might need to work around that a bit.

The click on the Connect button to join the room.

User Manual

The Web Client is pretty straight forward. You can mute your microphone and speakers by clicking on the icons in the bottom left control panel. On the left you’ll see all other users connected to the room. The web client also features a simple text chat and video chat.

Troubleshooting

Make sure that you use the same access key and room name as you use in your own integration. It’s always wise to douple check the correct entry of the access key.

Support

Please note, that we don’t provide support for this tool - as we use it internally for testing purposes it typically uses the latest SDK and server version - so if you experience any issues, please check if you use the latest version of the SDK and server. Please also make sure, that you entered your access key in the field Access Key and not the Access Token. The AccessToken field is just used if you don’t use a gateway but connect directly to an ODIN server.

`}),e.add({id:3646,href:"https://www.4players.io/odin/faq/general/what-license-is-your-sdk-under/",title:"What license is your SDK under?",section:"ODIN Documentation",description:"Understand the licensing of ODIN's SDKs, offering the flexibility of the MIT license for Unity, Unreal, Swift, Web SDKs, and the proprietary nature of our Core SDK.",content:`

Our SDKs for Unity, Unreal, Swift and the Web (and others) are licensed under the MIT license, you are free to use them and you can even modify them to your needs. However, all our SDKs include our Core SDK which is not open source and thus cannot be modified, in fact our license agreement prohibits you from reverse engineering our Core SDK.

`}),e.add({id:3647,href:"https://www.4players.io/odin/faq/general/can-i-use-google-cloud-functions-to-generate-access-tokens/",title:"Can I use Google Cloud Functions to generate access tokens?",section:"ODIN Documentation",description:"Effortlessly generate access tokens using Google Cloud Functions with our NodeJS example, detailed in our Token Server Example, for a smooth integration with ODIN.",content:`

Yes, you can use Google Cloud Functions to generate access tokens with your access key. We have an example on how to do this with NodeJS. Please see our Token Server Example for more information.

`}),e.add({id:3648,href:"https://www.4players.io/odin/faq/general/can-i-use-aws-lambda-to-generate-access-tokens/",title:"Can I use AWS Lambda to generate access tokens?",section:"ODIN Documentation",description:"Integrate ODIN seamlessly using AWS Lambda to generate access tokens. Our guide and NodeJS example in the Token Server Example simplify the process for you.",content:`

Yes, you can use AWS Lambda to generate access tokens with your access key. We have an example on how to do this with NodeJS. Please see our Token Server Example for more information.

`}),e.add({id:3649,href:"https://www.4players.io/odin/faq/general/can-i-use-azure-function-to-generate-access-tokens/",title:"Can I use Azure Function to generate access tokens?",section:"ODIN Documentation",description:"Learn how to use Azure Function with NodeJS to generate access tokens for ODIN, offering a seamless integration process as detailed in our Token Server Example.",content:`

Yes, you can use Azure Function to generate access tokens with your access key. We have an example on how to do this with NodeJS. Please see our Token Server Example for more information.

`}),e.add({id:3650,href:"https://www.4players.io/odin/faq/general/can-odin-record-a-rooms-audio-for-later-playback/",title:"Can ODIN record a room's audio for later playback?",section:"ODIN Documentation",description:"Discover ODIN's capabilities for recording room audio for playback, transcription, and content moderation, including easy implementation with our NodeJS and Bot SDKs.",content:`

Yes, ODIN can record a room’s audio and store it in a file. This file can be played back later. You can also use recording features to transcribe the audio for content moderation or automatic session notes. We provide a NodeJS SDK and a Bot SDK that allows you to implement these features in no time. And as everything is running on your side there are no issues with data protection, too.

We have an example on how to record and transcribe ODIN audio streams in real time. Read this guide to learn more.

`}),e.add({id:3651,href:"https://www.4players.io/odin/faq/general/i-cannot-connect-to-odin-what-can-i-do/",title:"I cannot connect to ODIN. What can I do?",section:"ODIN Documentation",description:"Troubleshoot connection issues with ODIN using our guide on QUIC/HTTP3 technology and how to communicate with your IT department for opening the required ports.",content:`

ODIN uses latest QUIC/HTTP3 technology and some administrators of cooperate office networks block ports required by this technology. Please check with your IT department if they can open the required ports. Please provide them this link to our firewall settings.

`}),e.add({id:3652,href:"https://www.4players.io/odin/faq/general/why-should-i-choose-odin-and-not-the-competition/",title:"Why should I choose ODIN and not the competition?",section:"ODIN Documentation",description:"Discover why ODIN stands out as an affordable, feature-rich solution for in-game communication, supported by a team with extensive experience in developing software for gamers.",content:`

We provide an affordable and feature-rich solution for any platform you’ll ever need. Our dedicated development team has years of experience developing communication software for gamers, and we’ll help you tailor exactly the immersive in-game experience that your players want.

ODIN has been built from scratch by industry leading voice engineers with your privacy and security in mind. In addition, ODIN provides the following key features:

Ultra-low latency and extremely low resource usage
Best-in-class voice quality with noise suppression
Built-in data protection and fully GDPR compliant
Support for thousands of concurrent users chatting at the same time with native 3D spatial audio support
Deep Unity and Unreal Engine integration
Zero maintenance and operations for clients but support for self-hosting if they want to (for sensitive areas)

This table should give you an overview how ODIN compares to other solutions.

Feature	ODIN	Photon	TeamSpeak	Agora	Vivox	EOS
Hosting & Pricing
Cloud hosting Let us deal with the setup, administration and bandwidth costs. ODIN leverages worldwide production-ready and battle-tested server infrastructure from 4Netplayers, who have been providing voice and game servers for more than 20 years.	✔	✔	✕	✔	✔	✔
Let us deal with the setup, administration and bandwidth costs. ODIN leverages worldwide production-ready and battle-tested server infrastructure from 4Netplayers, who have been providing voice and game servers for more than 20 years.
Self hosting ODIN infrastructure can be hosted on-premise. Run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. ODIN comes with Docker support for easy deployment wherever needed.	✔	✔	✔	✕	✕	✔
ODIN infrastructure can be hosted on-premise. Run our server software on your own infrastructure allowing you complete control and customization of your deployment environment. ODIN comes with Docker support for easy deployment wherever needed.
Traffic included Traffic costs can grow significantly if voice chat is used heavily or by many users and it’s hard to estimate those costs. Every month will have its surprise day when you get your invoice. Deals made for 4Netplayers with cloud and server providers all over the world allow us to include traffic costs in all our tiers. No hidden or hard to estimate costs for you.	✔	✕	✕	✕	✔	✔
Traffic costs can grow significantly if voice chat is used heavily or by many users and it’s hard to estimate those costs. Every month will have its surprise day when you get your invoice. Deals made for 4Netplayers with cloud and server providers all over the world allow us to include traffic costs in all our tiers. No hidden or hard to estimate costs for you.
Users per room How many users can join the same room to talk together. MMORPGs or larger battle royal games should be able to bring hundreds of users together. There is no limit for users per room at ODIN. However, there is a technical limit that depends on the implementation (i.e. a lot of voice communication, or more text and simple data). 2000 users should be no issues at all.	2000+	50	1000	128		16
How many users can join the same room to talk together. MMORPGs or larger battle royal games should be able to bring hundreds of users together. There is no limit for users per room at ODIN. However, there is a technical limit that depends on the implementation (i.e. a lot of voice communication, or more text and simple data). 2000 users should be no issues at all.
Platform & Engine Integration
Deep Unity Integration ODIN provides a full-featured Unity SDK and leverages Unity’s audio processing pipeline for capture and playback. Developers work with Unity tools they know like AudioSource and AudioMixers and get 3D positional audio automatically. ODIN fully integrates into more advanced 3D audio solutions and comes with a couple of examples and scripts for easy integration of different materials and their damping effects (like glass or concrete).	✔	✔	✕	✔	✕	✕
ODIN provides a full-featured Unity SDK and leverages Unity’s audio processing pipeline for capture and playback. Developers work with Unity tools they know like AudioSource and AudioMixers and get 3D positional audio automatically. ODIN fully integrates into more advanced 3D audio solutions and comes with a couple of examples and scripts for easy integration of different materials and their damping effects (like glass or concrete).
Deep Unreal Engine Integration Many voice SDKs are just a wrapper around browser based WebRTC libraries. ODIN offers native Unreal Engine (UE4 & UE5) support with simple to use Blueprint support for easy and reliable voice integration. Use the tools you know within the Unreal Engine.	✔	✔	✕	✕	✕	✔
Many voice SDKs are just a wrapper around browser based WebRTC libraries. ODIN offers native Unreal Engine (UE4 & UE5) support with simple to use Blueprint support for easy and reliable voice integration. Use the tools you know within the Unreal Engine.
Unreal Engine 5 support Unreal Engine 5 is best suited for large open-world games. This requires a reliable voice technology for as many users. ODIN is a great fit and offers full Unreal Engine 5 support.	✔	✕	✕	✕	✕	✔
Unreal Engine 5 is best suited for large open-world games. This requires a reliable voice technology for as many users. ODIN is a great fit and offers full Unreal Engine 5 support.
Web Support ODIN is available for the web as vanilla JavaScript script or `npm` package and can be integrated into websites or apps built with web technologies (like Angular, Vue, React, ReactNative, Svelte, …) in a couple of minutes. ODIN cross-platform compatibility allows users to interact (i.e. chat, realtime data synchronization) with each other independently where they are. Think about users talking within a CRM tool with users running in a virtual VR shopping center. All this is possible with ease with ODIN.	✔	✕	✕	✔	✕	✕
ODIN is available for the web as vanilla JavaScript script or `npm` package and can be integrated into websites or apps built with web technologies (like Angular, Vue, React, ReactNative, Svelte, …) in a couple of minutes. ODIN cross-platform compatibility allows users to interact (i.e. chat, realtime data synchronization) with each other independently where they are. Think about users talking within a CRM tool with users running in a virtual VR shopping center. All this is possible with ease with ODIN.
Swift SDK Apple developers are picky about their tools as they are used to work with the best tech. Our Swift SDK offers a quick and easy integration into the Apple eco-system. The SDK comes with Playgrounds to learn the SDK very quickly and integrates seamlessly with AVAudioEngine.	✔	✕	✕	✔	✕	✕
Apple developers are picky about their tools as they are used to work with the best tech. Our Swift SDK offers a quick and easy integration into the Apple eco-system. The SDK comes with Playgrounds to learn the SDK very quickly and integrates seamlessly with AVAudioEngine.
Core Communication Features
Native Spatial Audio Spatial audio is a feature that allows users to experience enhanced immersion and a sense of presence by creating a 3D soundscape that reflects the positions and movements of the participants within a virtual environment. This can help to create a more engaging and realistic experience for users, as the sound seems to be coming from the direction of the speaker, rather than from a fixed position in the room.	✔	✕	✔	✔	✔	✕
Spatial audio is a feature that allows users to experience enhanced immersion and a sense of presence by creating a 3D soundscape that reflects the positions and movements of the participants within a virtual environment. This can help to create a more engaging and realistic experience for users, as the sound seems to be coming from the direction of the speaker, rather than from a fixed position in the room.
Client-Server There are two basic networking topologies possible: Peer to Peer and Client-Server. In peer to peer solutions there is no central hub but each user must send his data to each other user. Data traffic grows exponentially with each additional user and does not work for more than 4 users reliable. Not considering issues with firewalls, NAT and many other shortcomings. Client-server software has a central hub and can handle thousands of users.	✔	✔	✔	✔	✔	✔
There are two basic networking topologies possible: Peer to Peer and Client-Server. In peer to peer solutions there is no central hub but each user must send his data to each other user. Data traffic grows exponentially with each additional user and does not work for more than 4 users reliable. Not considering issues with firewalls, NAT and many other shortcomings. Client-server software has a central hub and can handle thousands of users.
Latest technology Most voice SDKs are built on top of WebRTC. WebRTC is a monstrous library to manage all sorts of real-time communication into browsers. WebRTC is a very old and very complex piece of software. ODIN is built from scratch on latest tech like HTTP3/QUIC on a proprietary protocol that is developed with deep game engine integration and spatial 3D audio support in mind.	✔	✔	✕	✕	✕	✕
Most voice SDKs are built on top of WebRTC. WebRTC is a monstrous library to manage all sorts of real-time communication into browsers. WebRTC is a very old and very complex piece of software. ODIN is built from scratch on latest tech like HTTP3/QUIC on a proprietary protocol that is developed with deep game engine integration and spatial 3D audio support in mind.
Multi-room support Voice solutions typically use a room or channel based approach where all users connected to the same room or channel can talk to each other. Some use-cases require users to be able to join multiple rooms at the same time. ODIN comes with native multi-room support. Every user can join as many rooms as they like. There can be a 3D positional audio chat that mimics real voice and in addition to that users can have a walkie-talkie to talk to users that are out of reach. You can also define rooms that are just used to real-time data synchronization.	✔	✕	✔	✔	✔	✕
Voice solutions typically use a room or channel based approach where all users connected to the same room or channel can talk to each other. Some use-cases require users to be able to join multiple rooms at the same time. ODIN comes with native multi-room support. Every user can join as many rooms as they like. There can be a 3D positional audio chat that mimics real voice and in addition to that users can have a walkie-talkie to talk to users that are out of reach. You can also define rooms that are just used to real-time data synchronization.
Intrinsic data protection ODIN is completely stateless. The authentication works with a single token created by you per user and room that stores everything required for the service. This token is not stored anywhere in the ODIN infrastructure. Rooms are automatically created once the first user joins the room and are deleted once the last user left the room. There is no database in the background. ODIN does not collect or store any data at all.	✔	✕	✕	✕	✕	✕
ODIN is completely stateless. The authentication works with a single token created by you per user and room that stores everything required for the service. This token is not stored anywhere in the ODIN infrastructure. Rooms are automatically created once the first user joins the room and are deleted once the last user left the room. There is no database in the background. ODIN does not collect or store any data at all.
Real-time data synchronization ODIN allows developers to sync data per user and per room in real-time. Whenever something changes in this data-set, it’s synced with all other users connected to the same room in real-time. You can sync the players positions in real-time (i.e. geolocation in met averse applications) or a text-chat-history in a room with easy.	✔	✔	✕	✕	✕	✔
ODIN allows developers to sync data per user and per room in real-time. Whenever something changes in this data-set, it’s synced with all other users connected to the same room in real-time. You can sync the players positions in real-time (i.e. geolocation in met averse applications) or a text-chat-history in a room with easy.

`}),e.add({id:3653,href:"https://www.4players.io/odin/faq/general/does-this-affect-the-performance-of-my-game/",title:"Does this affect the performance of my game?",section:"ODIN Documentation",description:"Understand how ODIN's optimization ensures that your game's performance remains unaffected, allowing you to allocate all necessary resources to your game.",content:`

No. ODIN is highly optimized and we made sure, that you can allocate all the resources you need to your game.

`}),e.add({id:3654,href:"https://www.4players.io/odin/faq/general/which-target-platforms-and-architectures-are-supported/",title:"Which target platforms and architectures are supported?",section:"ODIN Documentation",description:"Explore the extensive range of target platforms and architectures supported by ODIN, including Windows, Linux, macOS, Android, iOS, and future support for gaming consoles.",content:`

We ship native dynamic libraries and/or frameworks for Windows, Linux, macOS, Android and iOS. Additionally, full native support for current and next-gen gaming consoles is implemented and can be deployed as part of your game.

Please note

Please reach out to us if you are planning to release for PlayStation4 and PlayStation 5 as there might be some preparations required on our side.

`}),e.add({id:3655,href:"https://www.4players.io/odin/faq/general/which-development-platforms-are-supported-and-how-can-i-use-this/",title:"Which development platforms are supported and how can I use this?",section:"ODIN Documentation",description:"Learn about the versatile support of ODIN for various development platforms, including pre-compiled binaries, C-style header files, and integration examples for Unity and Unreal Engine.",content:`

ODIN is shipped as a set of pre-compiled binaries as well as C-style header files and documentation, which makes it easy to use in any development project on any platform. We also provide packages with ready-to-use examples for Unity and Unreal Engine.

`}),e.add({id:3656,href:"https://www.4players.io/odin/faq/web/microphone-indicator-does-not-disappear/",title:"After leaving an Odin room, the microphone indicator in my tab does not disappear.",section:"ODIN Documentation",description:"Learn how to remove the microphone indicator and let the browser know, that the microphone is no longer in use.",content:`

Issue

When you disconnect from an Odin room by calling room.disconnect(), all media objects stop sending and receiving data. However, you might notice that the microphone indicator remains visible in your browser tab. This can lead users to believe that the microphone is still active.

Solution

To ensure the browser recognizes that the microphone is no longer in use, additional clean-up steps are necessary. The following function shows how to stop all media tracks associated with the microphone and remove them from the media stream:

Clean-up media tracks and hide microphone indicator

function stopMediaStream(ms: MediaStream) {
  ms.getTracks().forEach((track) => {
    track.stop();
    ms.removeTrack(track);
  });
}

Execute this clean-up function on the media stream that is capturing audio to make sure that all resources are properly released and the microphone indicator is removed.

`}),e.add({id:3658,href:"https://www.4players.io/odin/faq/unreal/build-crashes-on-startup-with-blueprint-only-project/",title:"Blueprint Only Projects: My packaged builds crash right after start-up",section:"ODIN Documentation",description:"Address the Odin plugin load error in Blueprint Only Unreal Engine projects by modifying the installation or converting the project type.",content:`

When the “Odin” plugin is installed directly into a Blueprint Only Unreal Engine project, you may encounter an error when trying to run packaged standalone builds. The error message typically states:

Plugin ‘Odin’ failed to load because module ‘Odin’ could not be found. Please ensure the plugin is properly installed, otherwise consider disabling the plugin for this project.

This issue occurs because Unreal Engine processes Blueprint Only projects differently, and fails to correctly package C++ plugins that are installed directly within the project.

Options for Resolving the Issue:

To resolve this issue, there are two options:

Install the Plugin in the Engine: By installing Odin Voice Chat directly into the Unreal Engine’s installation directory, Unreal will use a different method to package the Odin module when building a Standalone Version of your project. This method ensures that all required modules are accessible. To install the plugin in the engine you can either:
- Use Fab (Unreal Engine Marketplace) to install the Odin plugin
- Alternatively, download the appropriate version of the Odin plugin from the Odin SDK Unreal Releases Github page. Extract the plugin into the Engine’s marketplace plugins directory, which is typically located at .../Epic Games/UE_x.xx/Engine/Plugins/Marketplace
Convert Your Blueprint Only Project to a C++ Project: Adding C++ files to your project enables support for C++ based plugins like Odin being directly installed in your project folder. Here’s how to perform this conversion inside the Unreal Engine Editor:
1. In the Unreal Editor, navigate to Tools > New C++ Class > Choose Parent Class None
2. Give the class a name (e.g. Empty) and press Create Class.
3. Close down the Editor and open up the newly created Odin_Minimal.sln in your IDE
4. Build the project (Visual Studio hotkey is Ctrl+Shift+B)

Follow-Up Steps:

After following one of the solutions above, perform the following steps to ensure the Odin plugin loads correctly:

Open your Unreal project. If prompted, rebuild the missing modules by clicking Yes.
Go to Edit > Plugins in the Unreal Editor, and make sure that the Odin plugin is enabled.
Attempt to package your project again. The standalone version should now launch successfully without errors.

Following these guidelines will help you successfully integrate the Odin plugin into your Blueprint Only project or adjust your project’s setup to meet the plugin’s requirements.

`}),e.add({id:3659,href:"https://www.4players.io/odin/faq/unreal/build-error-building-for-but-attempting-to-link-with-file-built-for-unknown-unsupported-file-format/",title:"Build-error: building for ... but attempting to link with file built for unknown-unsupported file format",section:"ODIN Documentation",description:"Troubleshoot git LFS issues with Odin-Unreal-SDK and overcome errors related to unknown-unsupported file formats in Unreal. Follow our detailed steps to correctly clone and fetch large binary files.",content:`

If you encounter the following error:

... ignoring file /PROJECT_NAME/Plugins/Odin/Source/OdinCore/PLATFORM/..., 
building for PLATFORM but attempting to link with file built for unknown-unsupported file format 
( 0x76 0x65 0x72 0x73 0x69 0x6F 0x6E 0x20 0x68 0x74 0x74 0x70 0x73 0x3A 0x2F 0x2F )

it’s most likely due to issues with git LFS (large file storage). A standard clone of the ODIN-Unreal-SDK repository might only retrieve the metadata about these files managed with LFS. In order to retrieve the actual data with LFS, please follow these steps:

Clone the repository:

git clone https://github.com/4Players/odin-sdk-unreal.git

Cache the actual LFS data on your local machine and replace the metadata in the binary files with their actual contents:

git lfs fetch
git lfs checkout

… or if you have a recent LFS version:

git lfs pull

Next, move or copy the files into a new Odin sub-folder under your projects Plugins folder. It should end up looking like /MyProject/Plugins/Odin/.

`}),e.add({id:3660,href:"https://www.4players.io/odin/faq/unity/building-does-not-work-anymore-after-odin-integration/",title:"Building on macOS or iOS does not work anymore after Odin integration.",section:"ODIN Documentation",description:"Learn how to resolve build issues on macOS or iOS after integrating Odin by setting the microphone usage description in Unity player settings.",content:`

If you’re building for macOS or iOS, you need to set a microphone usage description in the player settings. Without this, the Unity editor will fail to build the target, often resulting in obscure error messages.

You can find this setting under Project Settings > Player > Other Settings > Configuration > Microphone Usage Description:

Unity macOS Microphone Usage description.

`}),e.add({id:3661,href:"https://www.4players.io/odin/faq/unreal/c-plus-plus-only-joinroom-does-not-trigger-callbacks-on-android--meta-quest-c-only-joinroom-does-not-trigger-callbacks-on-android--meta-quest/",title:"C++ only: JoinRoom does not trigger callbacks on Android / Meta Quest",section:"ODIN Documentation",description:"Solve FVector2D() initialization issues in UOdinRoomJoin::JoinRoom on Android with our guide. Avoid pitfalls with FVector2D constructor in Unreal Engine, and ensure your room join functionality works across platforms.",content:`

This is most likely an issue with using the standard FVector2D() constructor when setting the initialPosition of UOdinRoomJoin::JoinRoom. The standard FVector2D() will not explicitely initialize values. This doesn’t seem to be an issue on Windows, which will simply set the vector’s parameters to zero. Android on the other hand will require you to explicitely initialize the initialPosition with FVector2D(0,0) (or other explicit values).

This is not an issue when calling the Join Room node in blueprint.

`}),e.add({id:3662,href:"https://www.4players.io/odin/faq/unreal/cross-platform-engine-is-great-inside-the-web-client-i-can-hear-the-ue-client-but-i-cannot-hear-web-clients-inside-the-ue-client-why-does-it-not-work/",title:"Cross-Platform / Cross-Engine is great. Inside the web client I can hear the UE client, but I cannot hear web clients inside the UE client. Why does it not work?",section:"ODIN Documentation",description:"Resolve issues in the Odin Synth Component setup for 3D audio in Unreal. Get accurate player mapping and sound attenuation with our comprehensive guide. Improve your audio experience in voice chats.",content:`

Each client integrates their own MediaStream into the chat room, as detailed in our Unreal Manual. Once added, these streams are automatically transmitted to the ODIN server and then multicast to every peer in the same room.

By linking the MediaStream of each remote peer to a SynthComponent (for example, on a player character), audio communication is enabled among all participants. This setup allows everyone to hear each other, irrespective of the client type they are using. For more details on this process, refer to the OnMediaAdded event.

Excursion: Handling non-UE ODIN peers inside UE

Usually, every player character inside UE is spawned as soon as replicated by the network engine, i.e. Unreal networking. When an ODIN peer joins that cannot be replicated, you should either spawn a placeholder object “On Peer Joined” or you can attach the synth component of non-UE clients somewhere else “On Media Added”. For instance, you could attach it to your local player character to hear web clients with 2D audio like they are “on the phone”. Or you can put a virtual radio box inside the level to let web clients speak through that object. It is also possible to create a second ODIN room (e.g. “global chat”) and inside let all players from all client types communicate in 2D - in addition to the in-game (UE-only) spatial audio voice.

Remember to detach / destroy objects from non-UE ODIN peers when they leave the room.

`}),e.add({id:3663,href:"https://www.4players.io/odin/faq/unity/does-4players-odin-support-apple-silicon/",title:"Does 4Players ODIN support Apple Silicon?",section:"ODIN Documentation",description:"This document provides information on the support of 4Players ODIN for Apple Silicon. It emphasizes the importance of running the Unity Editor with Apple Silicon support and mentions that only Unity Editor versions 2021.2 and above are available for Apple Silicon",content:`

Yes. It does. But its important that you run the Unity Editor with Apple Silicon support. At time of this writing only version 2021.2 and above are available in an Apple Silicon version. Install the Unity Hub in version 3.x to install Apple Silicon Unity editor.

Using the Unity Hub to install Apple Silicon version

Download the Unity Hub here:

Download Unity Hub

`}),e.add({id:3664,href:"https://www.4players.io/odin/faq/",title:"FAQs",section:"ODIN Documentation",description:"Navigate through the ultimate FAQ index for the 4Players ODIN SDK, encompassing Popular Questions, General Queries, Unity FAQs, and Unreal Engine FAQs. This index provides quick access to a wide range of topics including plans, comparisons with Discord, text messaging capabilities, licensing, access token generation using cloud platforms, audio recording features, troubleshooting connection issues, performance impacts, platform support, integration timelines, Apple Silicon support in Unity, live audio feed access, dependencies in Unreal Engine, sound occlusion, Unreal Engine 5.x compatibility, and more. Ideal for developers and users seeking detailed information and solutions for integrating ODIN SDK into their projects.",content:""}),e.add({id:3666,href:"https://www.4players.io/odin/faq/general/",title:"General Questions",section:"ODIN Documentation",description:"Your go-to resource for frequently asked questions about the 4Players ODIN SDK. This comprehensive FAQ page covers everything from subscription plans, comparisons with Discord, text messaging capabilities, licensing, generating access tokens using cloud functions, audio recording, connectivity issues, performance impact, supported platforms, and integration timelines. Perfect for developers and users seeking detailed insights into the ODIN SDK's functionalities and advantages.",content:`

What plans do you offer?

Does ODIN also provide text message chat?

What license is your SDK under?

Can I use Google Cloud Functions to generate access tokens?

Can I use AWS Lambda to generate access tokens?

Can I use Azure Function to generate access tokens?

Can ODIN record a room's audio for later playback?

I cannot connect to ODIN. What can I do?

Why should I choose ODIN and not the competition?

Does this affect the performance of my game?

Which target platforms and architectures are supported?

Which development platforms are supported and how can I use this?

How long does it take to integrate ODIN?

`}),e.add({id:3667,href:"https://www.4players.io/odin/faq/unity/how-do-i-access-the-live-audio-feed/",title:"How do I access the live audio feed?",section:"ODIN Documentation",description:"Basic ODIN questions",content:`

Sometimes, for example if you want to do lip-syncing or if you want to add an graphical equalizer representing the audio coming from ODIN, you need to get access to the AudioSource and AudioClipfrom ODIN.

This is how you can get access to those information. Somewhere in your code, you attach the ODIN playback component representing a user to the game object using the function OdinHandler.Instance.AddPlaybackComponent. This will return an instance of PlaybackComponent. Use this component to get access to the AudioClip:

Playback = gameObject.GetComponent<PlaybackComponent>();
AudioSource source = Playback.PlaybackSource;
AudioClip clip = Playback.PlaybackSource.clip;

What is UserData?

Every peer (i.e. player) connected to ODIN has it’s own user data. Within ODIN, this is just a byte array that you can use for everything. We provide a class that provides basic user data as a JSON object. CustomUserDataJsonFormat exposes that interface and provides convenience functions for serialization.

You can set the user data before joining a room or you can also update the user data afterwards:

// Generate a JSON User Data object with the players netId and name in the network
CustomUserDataJsonFormat userData = new CustomUserDataJsonFormat(name, "online");
userData.seed = netId.ToString();

// Join ODIN Room ShooterSample and send user data
OdinHandler.Instance.JoinRoom("ShooterSample", userData.ToUserData());

The method ToUserData serializes the data stored in the CustomUserDataJsonFormat instance to a JSON string and FromUserData will take the serialized JSON string and return an instance of CustomUserDataJsonFormat as shown in this code snippet:

public void OnMediaRemoved(object sender, MediaRemovedEventArgs eventArgs)
{
    OdinUserData userData = OdinUserData.FromUserData(eventArgs.Peer.UserData);
    PlayerScript player = GetPlayerForOdinPeer(userData);
    if (player)
    {
        RemoveOdinPlaybackFromPlayer(player);
    }
}

Please check out our guide on user data:

Understanding User Data

`}),e.add({id:3668,href:"https://www.4players.io/odin/faq/general/how-long-does-it-take-to-integrate-odin/",title:"How long does it take to integrate ODIN?",section:"ODIN Documentation",description:"Discover the efficiency of our platform integration from early bird partner feedback. Tailor your feature set and get your first implementation running in less than one hour.",content:`

The actual integration time will vary based on the feature set you want to utilize, but we’ve had some initial feedback from our early bird partners, who had the first implementation running in less than one hour.

`}),e.add({id:3669,href:"https://www.4players.io/odin/faq/unreal/build-issues-when-installing-in-engine-and-project/",title:"How to address build issues with Odin installed in both the Engine and Project",section:"ODIN Documentation",description:"If you're facing build issues with the Odin plugin in Unreal Engine, follow these guidelines for troubleshooting and correcting the installation.",content:`

The Odin plugin can be installed either in the Engine’s Marketplace/Fab Plugins directory or in your current Unreal Engine Project directory. Installing the plugin in both the Engine Marketplace Plugins folder and the Project’s Plugins folder can cause conflicts with the UnrealBuildTool. Follow these steps to make sure the plugin is installed correctly and to resolve build issues:

Installation and Troubleshooting:

Close Your Project: Ensure that Unreal Engine is not running and your project is closed.
Clean Temporary Folders: Navigate to your project directory and delete the Binaries, Build, DerivedDataCache, and Intermediate folders.
Remove Redundant Plugin Installations: Ensure that the Odin plugin is only installed in one location. Remove it from the Engine’s Marketplace Plugins folder if it’s already in your Project’s Plugins folder.
Download and Install Plugin: Download the latest release of the Odin plugin for your Unreal Engine version from the Odin SDK Unreal Releases github page. For a clean install, please make sure to first completely remove the old Odin plugin folder. Then extract the downloaded release into your Project’s Plugins folder. The folder hierarchy should look similar to this: ../[ProjectName]/Plugins/Odin/Odin.uplugin
Regenerate Project Files: Right-click your project’s .uproject file, select “Generate Visual Studio project files”, and allow the process to complete.
Open Your Project and Rebuild: Double-click the .uproject file to open your project. If prompted, rebuild the missing modules by clicking ‘Yes’.
Reattempt the Build: Try to build a standalone version of your project again to see if the issue is resolved.

Following these steps will ensure that your plugin installation does not interfere with the UnrealBuildTool and your project builds successfully.

`}),e.add({id:3670,href:"https://www.4players.io/odin/faq/unreal/i-cannot-find-the-capture-audio-nodes/",title:"I cannot find the Capture Audio nodes?",section:"ODIN Documentation",description:"Find solutions to issues related to locating nodes in Blueprint for ODIN SDK. Ensure the 'Audio Capture' plugin is enabled in the Audio Section of Unreal Editor, enhancing your audio setup.",content:`

If you have any issues finding nodes in Blueprint, make sure the Audio Capture plugin is enabled. In the Unreal Editor open Plugins (Menu -> Edit -> Plugins) and make sure that in the Audio Section the Audio Capture plugin is activated like shown in this screenshot:

`}),e.add({id:3671,href:"https://www.4players.io/odin/faq/unity/i-get-an-unityexception-when-leaving-pie-or-loading-a-new-scene/",title:"I get an UnityException when leaving PIE or loading a new scene.",section:"ODIN Documentation",description:"Guidelines on handling UnityExceptions caused by get_dataPath. Learn best practices on room operations in Unity, including using the LeaveRoom function and the OnRoomLeft event, and tips for transitioning between scenes and shutting down the application.",content:`

UnityException: get_dataPath can only be called from the main thread.

Due to the asynchronous nature of leaving a room operation, the current recommendation is to avoid invoking this function within OnDestroy if the scene is being unloaded. Scene unloading could occur when transitioning between scenes or shutting down an application.

Instead, the best practice is to call the LeaveRoom function and subsequently wait for the OnRoomLeft event to be triggered. Once this event has been triggered, it is then safe to perform further actions, such as calling LoadScene or Application.Quit.

`}),e.add({id:3672,href:"https://www.4players.io/odin/faq/unity/libodin-cant-be-opened/",title:"libodin.dylib can't be opened because Apple cannot check it for malicious software",section:"ODIN Documentation",description:"Learn how to handle the following scenario: When trying to start Odin for the first time on macOS, you encounter the message: 'libodin.dylib can't be opened because Apple cannot check it for malicious software.",content:`

When attempting to start a scene with Odin for the first time on a macOS machine, you may encounter the following message:

Message while running Odin for the first time.

The libodin.dylib file is signed but not notarized, which causes this default message to appear. You can resolve this issue by following these steps:

Click on “Show in Finder” in the pop-up message.
In Finder, locate libodin.dylib, then right-click on it.
Select “Open With > Terminal.app”.
Click “Open” when prompted.
Wait until the terminal displays “Process completed”.

After completing these steps, try starting the scene again. The message should no longer appear.

`}),e.add({id:3673,href:"https://www.4players.io/odin/faq/unreal/cant-find-file/",title:"LogUObjectGlobals: Warning: [AssetLog] ... Can't find file Error when running a packaged build",section:"ODIN Documentation",description:"Encounter a warning about failing to load `/Script/Odin` after packaging your Unreal Engine project? Here’s how to fix redirector issues and ensure smooth asset loading.",content:`

If you encounter a warning that says

LogUObjectGlobals: Warning: [AssetLog] PATH_TO_ASSET\\.uasset: Failed to load '/Script/Odin': Can't find file.

while running your packaged Unreal Engine build, it typically indicates issues with asset redirectors. To resolve this, follow these steps:

Fixing Asset Redirectors:

Open Unreal Editor: Launch your Unreal Editor and open your project.
Select the Content Folder: In the Content Browser, right-click the root Content folder.
Fix up Redirectors: Choose “Fix up Redirectors” from the context menu. This action helps ensure all references are correctly updated and pointing to the valid assets.

After performing these steps, run your build again to check if the issue is resolved.

`}),e.add({id:3674,href:"https://www.4players.io/odin/faq/unreal/my-blueprint-nodes-are-broken/",title:"My blueprint nodes are broken after upgrading to a new Unreal Engine version. What's wrong?",section:"ODIN Documentation",description:"Learn how to manage your Odin plugin when upgrading Unreal Engine to avoid issues with blueprints and ensure a smooth transition between versions.",content:`

When upgrading to a new version of Unreal Engine, it is crucial to ensure that the Odin plugin is installed before opening your project in the new engine version. Following these steps can prevent the loss of blueprint functionality:

Pre-upgrade preparation: Before upgrading to a newer Unreal Engine version, confirm that the Odin plugin is available and supported in the new version.
Install before opening: Install the Odin plugin in the new version of Unreal Engine before opening your project. This helps to ensure that all Odin-related blueprints and functionalities remain intact.
Delete Intermediate and Binaries folders: To avoid any intermediate files conflicting with newer Engine or Plugin version, delete the Binaries, Build, DerivedDataCache and Intermediate folders in your project directory and the Binaries and Intermediate folders in your [Projectfolder]/Plugins/Odin directory.
Do not compile without Odin: Avoid compiling any of your blueprint nodes if the Odin plugin is not installed in the new Unreal Engine version. Compiling without the plugin can lead to irreversible damage to Odin-dependent blueprints.
Handling accidental compiles: If you have accidentally compiled one of your blueprints without the Odin plugin, attempt to revert to a previous stable version of your project using your source control system.

Following these guidelines will help you maintain the integrity of your project and avoid potential setbacks when transitioning between Unreal Engine versions with the Odin plugin installed.

`}),e.add({id:3675,href:"https://www.4players.io/odin/faq/unity/roomupdateposition-does-not-work-or-works-incorrectly/",title:"room.UpdatePosition does not work or works incorrectly",section:"ODIN Documentation",description:"Guidelines for using ODIN room in Unity with tips on setting position scale and updating position",content:`

Please make sure to follow these tips:

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. You can set the position scale using room.SetPositionScale.
Invoking room.UpdatePosition too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling room.UpdatePosition to a maximum of 10 times per second. This equates to one update every 100 milliseconds. We recommend using Unity’s Coroutines to update the position in Odin rooms.

`}),e.add({id:3676,href:"https://www.4players.io/odin/faq/unreal/spatial-audio-does-not-work-what-is-wrong/",title:"Spatial audio does not work. What is wrong?",section:"ODIN Documentation",description:"Resolve issues in the Odin Synth Component setup for 3D audio in Unreal. Get accurate player mapping and sound attenuation with our comprehensive guide. Improve your audio experience in voice chats.",content:`

If the voice chat is working und you managed to hear other players, but it sounds like they are always “inside your head”, please look Add Odin Synth Component ">here and check if you set the right target for the Odin Synth Component.

If you used this blueprint example, you have to be careful to choose the right player character for every single event as mentioned in the info box below.

Info

“In a real 3D shooter with 3D audio you would not choose the local player, but map the Odin Peer Id with your Unreal Player Id and then assign the Media to the corresponding player character. This way, Unreal will automatically process the audio in its audio engine and apply attenuation, i.e. dampen the volume the farther away the player is from the listener.”

If everything is connected correctly, more details on Sound Attenuation can be found in the Unreal Documentation

Explore our comprehensive Unreal Tech Demo Project for a hands-on learning experience on setting up Proximity Voice Chat in a Multiplayer Game. This demo project is designed to guide you through the key steps and considerations for integrating proximity-based voice communications effectively.

For a more interactive learning journey, we also offer an extensive Unreal video tutorial series. This series provides step-by-step instructions on configuring Proximity Voice Chat, ensuring a thorough understanding of the process from start to finish.

`}),e.add({id:3678,href:"https://www.4players.io/odin/faq/unity/",title:"Unity FAQs",section:"ODIN Documentation",description:"Dive into our comprehensive FAQ section dedicated to Unity integration with the 4Players ODIN SDK. Find solutions to common issues like Apple Silicon support, accessing live audio feeds, handling UnityExceptions, and troubleshooting room.UpdatePosition. Our guide is designed to streamline your experience with ODIN in Unity environments, ensuring smooth and efficient application development.",content:`

Building on macOS or iOS does not work anymore after Odin integration.

Does 4Players ODIN support Apple Silicon?

How do I access the live audio feed?

I get an UnityException when leaving PIE or loading a new scene.

libodin.dylib can't be opened because Apple cannot check it for malicious software

room.UpdatePosition does not work or works incorrectly

Which platforms does ODIN support for Unity?

`}),e.add({id:3680,href:"https://www.4players.io/odin/faq/unreal/",title:"Unreal FAQs",section:"ODIN Documentation",description:"Explore our in-depth FAQ page for integrating 4Players ODIN SDK with Unreal Engine. Get answers to crucial questions about plugin dependencies, sound occlusion, Unreal Engine 5.x support, build errors, cross-platform communication, spatial audio, and more. Whether you're facing challenges with audio capture, peer positioning, or simply want to customize your audio experience, our guide provides the insights you need for a successful Unreal Engine integration.",content:`

Are there any dependencies to other plugins?

I'm having Issues with Echo Cancellation, what can I do?

Do you have sound occlusion built-in?

Do you support Unreal Engine 5.x?

Blueprint Only Projects: My packaged builds crash right after start-up

Build-error: building for ... but attempting to link with file built for unknown-unsupported file format

C++ only: JoinRoom does not trigger callbacks on Android / Meta Quest

Cross-Platform / Cross-Engine is great. Inside the web client I can hear the UE client, but I cannot hear web clients inside the UE client. Why does it not work?

How to address build issues with Odin installed in both the Engine and Project

I cannot find the Capture Audio nodes?

LogUObjectGlobals: Warning: [AssetLog] ... Can't find file Error when running a packaged build

My blueprint nodes are broken after upgrading to a new Unreal Engine version. What's wrong?

Spatial audio does not work. What is wrong?

Update Peer Position does not work or works incorrectly

What if I do not want to have spatial audio, just like in my favourite conferencing software?

My issue is not listed in the FAQs, what should I do?

`}),e.add({id:3681,href:"https://www.4players.io/odin/faq/unreal/update-peer-position-does-not-work-or-works-incorrectly/",title:"Update Peer Position does not work or works incorrectly",section:"ODIN Documentation",description:"Elevate the performance of Odin Rooms in Unreal with our insightful tips. Ensure optimal setup by correctly using Set Room Position Scale and minimal Update Peer Position calls for seamless audio stream optimization.",content:`

Please make sure to follow these tips:

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. You can set the position scale using Unreal Set Room Position Scale ">Set Room Position Scale.
Invoking Unreal Update Peer Position ">Update Peer Position too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling Update Peer Position to a maximum of 10 times per second. This equates to one update every 100 milliseconds. We recommend using Unreal’s Set Timer by Event node to update the position in Odin rooms.

`}),e.add({id:3683,href:"https://www.4players.io/odin/faq/web/",title:"Web FAQs",section:"ODIN Documentation",description:"Dive into our comprehensive FAQ section dedicated to Web SDK integration with the 4Players ODIN SDK.",content:`

After leaving an Odin room, the microphone indicator in my tab does not disappear.

`}),e.add({id:3684,href:"https://www.4players.io/odin/faq/unreal/what-if-i-do-not-want-to-have-spatial-audio-just-like-in-my-favourite-conferencing-software/",title:"What if I do not want to have spatial audio, just like in my favourite conferencing software?",section:"ODIN Documentation",description:"Resolve issues in the Odin Synth Component setup for 3D audio in Unreal.",content:`

Like in the answer to the question above “Spatial audio does not work. What is wrong?” you can do the contrary and set the synth component to playback only in 2D. Look in the Unreal Documentation here.

`}),e.add({id:3685,href:"https://www.4players.io/odin/faq/unity/which-platforms-does-odin-support/",title:"Which platforms does ODIN support for Unity?",section:"ODIN Documentation",description:"This document provides information on the support of specific platforms for ODIN Voice Chat by 4Players when using Unity.",content:`

ODIN does officially support the following platforms for Unity:

Windows (x64)
MacOS (Universal)
iOS (Universal)
Android (ARM64)

For additional platform support, please contact us!

Note: WebGL will be supported soon with version 2.0

`}),e.add({id:3686,href:"https://www.4players.io/odin/faq/unreal/my-issue-is-not-listed/",title:"My issue is not listed in the FAQs, what should I do?",section:"ODIN Documentation",description:"If you encounter an issue with your project that isn't covered in our existing FAQs, follow these steps to troubleshoot and how to look for further assistance.",content:`

If you encounter an issue with your project that isn’t covered in our FAQs, here are some troubleshooting steps you can try before looking for further assistance:

Recommended Troubleshooting Steps:

Delete Intermediate Folders: This can resolve issues caused by corrupted files. Close Unreal Engine, navigate to your project directory, and delete the Binaries, Build, DerivedDataCache and Intermediate folders. If Odin is installed in the project, navigate to the Plugin directory ([Project Path]/Plugins/Odin) and delete the Binaries and Intermediate folders.
Regenerate Visual Studio Project Files (for C++ projects): Right-click your .uproject file and select “Generate Visual Studio project files”.
Install the Plugin Directly in the Project: We recommend installing the Odin plugin directly in your project. This approach enhances compatibility and ensures that the plugin is included in your source control, making it available to all project members. To install the plugin in your project:
- Download the latest plugin version for your Unreal Engine version from Odin SDK Unreal Releases.
- Extract the plugin into your project’s Plugins folder. If this folder does not exist, create it.
- Restart Unreal Engine and enable the plugin through the ‘Plugins’ menu.

Further Assistance:

If the issue is still present after following the above steps, you can ask for further assistance through our Discord:

Join Our Discord: Join here if you’re not already a member.
Post in the Support Channel: Navigate to the #odin-unreal channel and describe your issue. Include the following:
- A detailed description of the problem.
- Any relevant screenshots or error logs.
- The Odin plugin version and the Unreal Engine version used in your project.
- Steps you have already tried.

Our community and support team will then take a look at your request and help you as quickly as possible. Thank you for your patience!

`}),e.add({id:3687,href:"https://www.4players.io/odin/license/2025-05-27/",title:"ODIN License Agreement",section:"ODIN Documentation",description:"",content:`

This Agreement outlines the licensing terms for the ODIN SDK provided by 4Players GmbH (“4Players”) to the Licensee (4Players and the Licensee each a “Party” and together the “Parties”):

Scope of the Agreement

1.1

4Players has developed the ODIN software, a cross-platform software development kit (“ODIN SDK”) that enables developers to integrate real-time chat technology into multiplayer games, apps and websites. ODIN SDK provides a complete, out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers. Besides, 4Players hosts the servers, handles the network and the audio processing that is required for voice communication (the “ODIN Server”).

1.2

By utilizing the ODIN SDK (see Section 2. Right to use), the “Licensee” accepts the terms outlined in this Agreement. This acceptance grants the Licensee the right to use the ODIN SDK under the conditions specified herein.

1.3

Licensees are entitled to use the ODIN SDK for development and testing purposes under the following conditions:

Free access, enabled by a complimentary access code for the 4Players cloud, supports up to 25 concurrent users, ideal for initial development and testing (“Free Use”).
Should the Licensee exceed this 25-user limit, move towards a public launch (including public beta or early access), or require on-premise hosting, a transition to a paid subscription is necessary. Options for cloud hosting or on-premise hosting can be purchased directly from the 4Players website. For unique needs, our sales team is available to provide customized offers (“Fee-Based Use”).

1.4

The Licensee can choose from the following hosting options:

On-Premise Hosting: The Licensee receives the right to host instances of the ODIN Server independently. These instances must consistently report telemetry data to 4Players, to enable optimal operation and support.
Cloud Hosting: The Licensee receives access to the ODIN Server, which is managed and maintained by 4Players. This option provides a hassle-free, comprehensive solution without the need for the Licensee to handle server-side processing or maintenance.

Regardless of which option the Licensee chooses, he is authorized to utilize the ODIN SDK in accordance with the terms set out in this Agreement, ensuring a flexible and scalable solution for integrating real-time chat technology into various digital platforms. Irrespective of whether the Licensee chooses a hosting option or not, this Agreement exclusively governs the right to use ODIN SDK.

Right of Use

2.1

4Players hereby grants the Licensee a worldwide, royalty-free, non-exclusive and non- transferable right to use the ODIN SDK (the “License”) in accordance with Section 2.2, together with Licensee owned and/or licensed software and technology which Licensee uses and integrates with the ODIN SDK (the “Licensee Software”).The License is limited in time to the term of this Agreement.

2.2

The License serves to improve the real-time communication capabilities within the Licensee’s applications and is limited exclusively for the following purposes:

Integration: The Licensee is granted the right to incorporate the ODIN SDK into its application(s). This involves implementing the ODIN SDK according to the guidelines and documentation provided by 4Players.
Operation: Upon successful integration, the Licensee is authorized to operate the ODIN SDK and ODIN Server to facilitate real-time voice communication within its application(s).
Enhancement: Licensee is permitted to use the ODIN SDK's capabilities to enrich user interaction within its application(s), including but not limited to enabling community discussions, virtual meetings, training sessions, or other activities that necessitate real-time communication or real-time data synchronization.

The rights granted under this agreement do not cover activities beyond the expressly stated scope. The License does not include any form of sublicensing, transferring, selling, renting, or otherwise distributing the ODIN SDK to third parties unless explicitly authorized by 4Players in writing. Furthermore, modifications, reverse-engineering, or alterations to the source code of the ODIN SDK or ODIN Server are not permitted.

2.3

During the term of this Agreement, the Licensee is entitled to download the current version of the ODIN SDK from the website of 4Players or Github (github.com/4players). Documentation is provided online at 4players.io/odin.

2.4

The Licensee acknowledges and confirms that he has tested the ODIN SDK integration in its target system environment using the free access key provided to ensure the compatibility and performance meet his requirements. If the Licensee opts for On- Premise Hosting, he is solely responsible for testing and ensuring that the system environment is suitable for the optimal operation of the ODIN Server.

2.5

The right to decompile the ODIN SDK granted to Licensee herein is only granted under the terms of Section 69e para. (1) nos. 1 to 3 UrhG and within the limits of Section 69e para. (2) nos. 1 to 3 UrhG.

2.6

Except as set out in this Agreement, no rights to use the ODIN SDK or ODIN Server are granted to the Licensee.

IP Rights

3.1

The Parties acknowledge and agree that 4Players is the sole owner of the Intellectual Property Rights in the ODIN SDK and the ODIN Server (including the respective source code). This applies also if and to the extent that 4Players will – at the request of the Licensee – render services which effects, changes or modifies the ODIN SDK or ODIN Server. Except as set out herein, the Licensee shall not acquire or receive any rights with regard to the ODIN SDK.

3.2

All documentation, documents, data, plans and other information provided by either Party to the other Party in connection with this Agreement shall be used only for the purposes of this Agreement and shall remain the exclusive property of the providing Party.

3.3

The Licensee shall retain (to the extent applicable) and own all rights in the Licensee Software (including its respective source codes), his personal data, all data gathered by Licensee whilst using the ODIN SDK and ODIN Server, and all deliverables arising out of or in connection with this Agreement.

3.4

Each Party undertakes not to challenge the Intellectual Property Rights of the other Party, nor to have them challenged by third parties, nor to support third parties in any way in the challenge.

3.5

“Intellectual Property Rights” means all inventions, patents, software, copyrights, mask, works, industrial property rights, trademarks, trade secrets, know-how, proprietary information and rights and information of a similar nature. Such information includes, without limitation, designs, processes, drawings, prints, specifications, reports, data, technical information, and instructions.

Warranty

4.1

4Players is not obliged under this Agreement, to remedy any malfunction or defect in the ODIN SDK, unless expressly agreed otherwise by the Parties.If the Licensee has entered into a separate agreement with 4Players on the fee-based use of the ODIN Server, the following shall apply in deviation from Section 4.1:The statutory provisions shall apply unless otherwise stipulated below.

4.2

If the Licensee detects any malfunctions or defects of ODIN SDK, he must notify 4Players immediately.

4.2.3

Rights in case of malfunctions or defects shall be excluded in the case of minor or immaterial deviations from the agreed or assumed characteristics. Product description shall not be deemed guaranteed by 4Players unless the product description including the ODIN SDK description is set out in this Agreement or otherwise agreed separately in writing. In respect of updates, upgrades and the delivery of new versions of the ODIN SDK, Licensee’s rights in case of defects shall be limited to the new features of the update, upgrade or new version compared to the previous version release.

4.2.4

In case of a malfunction or a defect of ODIN SDK, 4Players shall remedy such malfunction or defect in accordance with the provisions of the Service Level Agreement (SLA) included with the Fee-Based Usage subscription. For the avoidance of doubt, the SLA shall only apply if the Licensee has concluded a separate agreement with 4Players on the fee-based use of the ODIN Server. Otherwise, the Licensee has no rights under the SLA.

4.3

4Players is not responsible for any changes or additions to the ODIN SDK made by the Licensee himself or by third parties. 4Players is also not responsible for defects, which are caused by improper use by the Licensee.Any claims for damages are subject to the limitations set forth under Section 6.

Rights in Case of Defects in Title

5.1

If third parties assert rights to the ODIN SDK against the Licensee, he shall inform 4Players immediately in writing of the assertion of such rights and shall give 4Players all powers of attorney and authorisations necessary to defend ODIN SDK against the asserted rights of third parties.

5.2

4Players shall do everything in its power, in order to defend ODIN SDK at its own expense against the claims of third parties.

5.3

To the extent that there are defects in title, 4Players is entitled at its option to either (i) take legitimate measures to remove the third party rights, which impair the contractual use of ODIN SDK, or (ii) remedy the enforcement of such claims, or (iii) change or replace ODIN SDK in such a manner, that it no longer infringes the rights of third parties, provided and to the extent that this does not substantially impair the functionality of ODIN SDK.

5.4

The Licensee is not entitled to any rights under Section 5.2 or Section 5.3 if he has not concluded an agreement with 4Players on the fee-based use of the ODIN Server.

Liability

6.1

The liability of 4Players shall be limited to the following:

6.1.1

4Players shall be unrestricted liable i) in the event of malice, intent or gross negligence; ii) within the scope of a guarantee expressly assumed by 4Players; iii) for damages arising from injury to life, limb or health; and iv) in accordance with the provisions of the German Product Liability Act (ProdHaftG).

6.1.2

4Players shall be liable for the breach of a material contractual obligation, the fulfilment of which is a prerequisite for the proper performance of the Agreement and on the observance of which the Licensee regularly relies and may rely (cardinal obligation). In the case and simple negligence, however, the liability shall be limited to the amount which was foreseeable by 4Players at the time the respective service was performed.

6.1.3

Besides, the liability of 4Players is excluded.

6.2

The Licensee is obliged to prevent and minimise damage, for example through data backup and state-of-the-art virus defence.

Term and Termination

7.1

This Agreement is concluded for an indefinite period. It can be terminated at any time with a notice period of 3 months to the end of each calendar month. A deviating agreement, in particular a separate agreement with 4Players on the fee-based use of the ODIN Server, shall prevail.

7.2

The right to terminate this Agreement for good cause shall remain unaffected. Such good cause for an extraordinary termination exists, in particular, if the Licensee uses the ODIN SDK without a separate agreement with 4Players on the fee-based use of the ODIN Server, although the requirements for Free Use within the meaning of section 1 are not met.

Confidentiality

8.1

The Parties agree to keep all confidential information which becomes known to them during the performance of this Agreement strictly confidential and only to use such information for the contractually agreed purposes. Confidential information for the purpose of this provision shall mean information, documents, details and data, which is marked as such or is to be seen as confidential because of its nature. The Parties shall not seek to register intellectual property rights in respect of confidential information of the other Party.

8.2

If confidential information within the above definition is requested by a public authority, then the other Party shall be informed without delay and before the information is supplied to the public authority.

8.3

The rights and obligations under 8.1 and 8.2 shall not be affected by the termination of this Agreement. Both Parties agree at the option of the other Party to return or destroy the confidential information of the other party upon the termination of this Agreement, to the extent that such information still exists.

Data Protection

9.1

The Parties shall comply with the statutory provisions on data protection, in particular the provisions of the General Data Protection Regulation (GDPR) and the German Federal Data Protection Act (BDSG), and shall obligate and train their employees accordingly. The Parties shall inform each other if the processing of personal data is necessary for the execution of this Agreement.

9.2

The Parties will conclude a data processing agreement (Art. 28 GDPR), if required.

10.

Final Provisions

10.1

Amendments or additions to this Agreement must be made in writing to be effective (email is sufficient). This shall also apply to amendments of this written form requirement. General terms and conditions of the Licensee shall not apply unless 4Players has expressly approved them in writing – even if their validity has not been expressly contradicted.

10.2

4Players shall have no right to use Licensee’s names, trademarks, trade names, or logos without the prior written consent of Licensee in each instance.

10.3

This Agreement shall be governed by the laws of the Federal Republic of Germany except for the UN Sales Convention.

10.4

The exclusive place of jurisdiction for all disputes arising directly or indirectly from the contractual relationship shall be at the registered registered office of 4Players. This does not apply if the Licensee is a consumer within the meaning of Section 13 German Civil Code (BGB).

10.5

Should any provision of this Agreement be or become invalid, this shall not affect the validity of the remaining terms. The Parties shall in such an event be obliged to cooperate in the creation of terms which achieve such legally valid result as comes closest commercially to that of the invalid provision. The above shall apply accordingly to the closing of any gaps in the Agreement.

`}),e.add({id:3688,href:"https://www.4players.io/odin/license/",title:"ODIN License Agreement",section:"ODIN Documentation",description:"The License Agreement for using ODIN by 4Players",content:`

Welcome to the License Agreement section of our website. Here you will find the terms and conditions governing the use of the ODIN SDK provided by 4Players GmbH. These agreements outline the rights and responsibilities of both 4Players and the Licensee, and they become effective whenever you download and use the ODIN SDK.

The License Agreement covers various aspects, including:

The scope of the agreement
The rights granted to the Licensee
Intellectual property rights
Warranty and liability provisions
Termination clauses
Confidentiality and data protection

By downloading and using the ODIN SDK, you agree to comply with the terms set forth in the respective License Agreement version that applies to your download date.

You can find the latest version of the License Agreement below, along with links to previous versions for reference.

License Agreement Versions

Below is a list of the different versions of our License Agreements, with the most recent version listed first:

Version	Effective Date	Description
2025-05-27 (latest)	2025-05-27	Initial release of the License Agreement.

If you have any questions or need further assistance, please do not hesitate to contact our support team.

Thank you for using the ODIN SDK. We are committed to providing a robust and reliable platform for your development needs.

`}),e.add({id:3689,href:"https://www.4players.io/odin/pricing/",title:"Pricing",section:"ODIN Documentation",description:"ODIN provides fair pricing for exceptional services.",content:`

Please head over to our product pages to learn more about pricing.

`}),e.add({id:3690,href:"https://www.4players.io/blog/farming-simulator-25-pre-order-bundle/",title:"Farming Simulator 25 Pre-Order Bundle: Secure Your Server Now with Exclusive Bonuses!",section:"4Players Blog",description:"We have put together an exclusive pre-order bundle for our dedicated players that’s packed with amazing perks. Don't Miss Out – Pre-Order Now!",content:`

Great news, Farming Simulator fans! 4Netplayers is excited to announce the continuation of our successful partnership with GIANTS Software, the creators of the Farming Simulator series. With the release of Farming Simulator 25 just around the corner, we’ve put together an exclusive pre-order bundle for our dedicated players that’s packed with amazing perks!

What’s in the Pre-Order Bundle?

Starting today, when you pre-order your Farming Simulator 25 game server, you’ll get access to some serious bonuses that will enhance your gaming experience:

25 GB of Free Mod Space: Customize your farm and gameplay to your heart’s content without worrying about storage space.
Up to 3 Months of Free Server Hosting: That’s right! Get more playtime on us with up to 3 months of free hosting, depending on the plan you choose.
Exclusive Merch Package: Show off your love for Farming Simulator with a limited-edition merch bundle, available only through 4Netplayers pre-orders.

Don’t Miss Out – Pre-Order Now!

Our servers are optimized for Farming Simulator 25, ensuring a smooth, lag-free experience for you and your friends. Plus, with our automated backups, updates, and easy-to-use interface, you can focus on farming instead of server management. Pre-order now and secure your spot!

👉 Pre-order your Farming Simulator 25 server today!

Attention, Affiliate Partners!

This pre-order promotion isn’t just for our gaming customers—it’s a huge opportunity for our affiliate partners as well. With our generous affiliate program, you can earn 50% of the first net monthly payment from your referrals. Additionally, you’ll have access to customizable €5 discount codes to attract even more customers.

Affiliate materials are available on our Affiliate Hub, or you can sign up through Adcell or Awin to start promoting today!

4Players and GIANTS Software

`}),e.add({id:3691,href:"https://www.4players.io/blog/voice-chat-sdk-odin-back-in-unity-asset-store/",title:"ODIN Voice Chat is back in Unity Asset Store",section:"4Players Blog",description:"Our out-of-the-box voice chat solution is now available again in the Unity Asset Store. 4Players is now also a certified partner of Unity, making ODIN Voice Chat a Verified Solution, meeting Unity’s highest quality and compatibility standards.",content:`

Now in Unity Asset Store!

ODIN Voice is now available again in the Unity Asset Store. Head over to download and install the SDK for free!

You can download, install and use the SDK for free for up to 25 peak concurrent users by either generating a free access key in our developer documentation or directly in the Unity Editor using the Odin Manager Prefab.

4Players becomes partner of Unity

We thank Unity for the frictionless and thorough verification process to make ODIN Voice Chat a Verified Solution, meaning it meets Unity’s highest quality and compatibility standards. They were very responsive and did an amazing job getting our Odin Plugin reviewed for public release in the Unity Asset Store.

More to come

Our Unity Tech Demo has been further developed and will also be released on the Unity Asset Store soon. In addition, we are working on the new version 2.0 of our plugin with many improvements and webGL support, among other things.

We can’t wait to see what you are developing with ODIN on the amazing Unity Engine.

Please contact sales if you need additional information on pricing and get in touch with our Customer Success Team if you want to be part of our “Showcase”.

Get ODIN from Unity Asset Store

`}),e.add({id:3692,href:"https://www.4players.io/blog/4netplayers-is-joing-forces-with-medion/",title:"4Netplayers is joining forces with MEDION",section:"4Players Blog",description:"Get three months of 4Netplayers gaming servers for free when you buy a computer from Medion's ERAZER gaming line.",content:`

Get ready for an exciting collaboration between Medion and 4Players that will take your gaming experience to the next level! Soon, we’re launching an exclusive promotion where every purchase of a Medion Erazer gaming PC will include a fully-featured 4Netplayers game server for three months, free of charge – a value of €40!

What to Expect:

During the promotional period, when you purchase a powerful Medion Erazer gaming PC, you’ll receive a free 4Netplayers game server to dive right into multiplayer gaming! Our servers come with ultra-low latency, automatic backups, and easy setup, ensuring you get the most out of your games.

How It Works:

Purchase a Medion Erazer gaming PC once the promotion goes live.
You’ll receive a code for 3 months of free server hosting from 4Netplayers.
Redeem your code, set up your server, and start gaming with friends immediately!

👉 Explore the Medion Erazer lineup here

Stay Tuned!

The promotion is launching soon—keep an eye out and stay informed! You won’t want to miss out on this fantastic opportunity. We’ll keep you posted with updates right here and across our channels.

`}),e.add({id:3693,href:"https://www.4players.io/blog/4players-accounces4players-launches-odin-rooms-an-ultra-secure-decentralized-browser-based-video-conferencing-tool/",title:"4Players Launches Rooms: An Ultra-Secure Decentralized Browser-Based Video Conferencing Tool",section:"4Players Blog",description:"Discover Rooms, a new decentralized video conferencing tool by 4Players offering ultra-secure, browser-based communication with no data storage. Free for small businesses, NGOs, and educational use.",content:`

We’re thrilled to announce the launch of Rooms, our ultra-secure, decentralized video conferencing platform built on ODIN Voice. Designed with security and privacy at its core, Rooms is built for businesses, educators, NGOs, and individuals looking for more control over their communications.

With ODIN Rooms, there’s no need for accounts or app installations—simply click a link and join a secure, encrypted conversation. Plus, for those who prioritize data control, the platform is fully self-hostable.

We’re offering free access for small businesses, NGOs, and educational institutions, and we’re excited to announce that key parts of the platform will soon be open-source!

Rooms is more than just a tool—it’s a move toward safer, decentralized communication. Check out more details and try Rooms here.

Thanks to the whole team at 4Players that have been working hard to bring this project to life.

Stay tuned for future updates, and feel free to reach out if you have any questions!

Press contact:

Susanne Kasberger
PR & Corporate Communications
4Players GmbH
Deelbögenkamp 4, 22297 Hamburg, Germany
Email: susanne.kasberger@4players.io

`}),e.add({id:3694,href:"https://www.4players.io/blog/4players-changes-terms-and-services/",title:"We have adjusted our Terms and Services",section:"4Players Blog",description:"Starting with Rooms today we have updated our Terms and Services. Read more about the changes.",content:`

We have updated our Terms of Service to include specific rules for our new product, Rooms. These changes primarily apply to users who choose to host video conferencing on our platform. Importantly, there are no changes to the terms for existing users. The only significant adjustment for everyone is a minor renumbering of sections. You can review the updated terms here.

`}),e.add({id:3695,href:"https://www.4players.io/blog/4players-releases-odin-for-unreal-engine-5.4/",title:"ODIN brings support for Unreal Engine 5.4",section:"4Players Blog",description:"Discover the latest enhancements in ODIN SDK v1.6.5, now fully compatible with Unreal Engine 5.4. This update offers critical fixes and new features designed to optimize real-time voice communication in your games and applications. Learn how the new changes can elevate your project's performance.",content:`

We are thrilled to announce the release of the latest update for our ODIN Software Development Kit (SDK), now fully supporting Unreal Engine 5.4. This update brings a series of enhancements and fixes that solidify ODIN’s position as a leading voice communication solution for game developers and digital creators. Here’s everything you need to know about the ODIN SDK v1.8.7 update:

What’s New in v1.8.7?

Core SDK Upgrade: The heart of ODIN, the Core SDK, has been upgraded to version 1.6.5. For a detailed view of the enhancements and new capabilities, check out the release notes on our GitHub page.
iOS Build Fixes: We’ve addressed and fixed build issues that previously affected iOS, enhancing stability and compatibility across all supported Apple devices.
Enhanced Asynchronous Event Handling: The update introduces world validity checks for asynchronous events to ensure smooth synchronization with the game environment, minimizing disruptions during gameplay.
Improved Safety with UOdinRoom References: Changes have been made to how UOdinRoom references are accessed, which now prevents potential crashes related to asynchronous event handling—boosting the overall robustness of the SDK.
Support for Unreal Engine 5.4: Last but not least, we’ve added support for the latest Unreal Engine 5.4 releases, allowing developers to integrate ODIN’s cutting-edge voice communication technology with the newest features from one of the most powerful game engines available today.

Why Update? Updating to ODIN SDK v1.8.7 ensures that developers can take full advantage of the latest improvements in voice communication technology. Whether you’re developing an interactive game, a VR experience, or an educational tool, this update is designed to enhance your application’s performance and stability.

Stay ahead of the curve by integrating the latest version of ODIN SDK into your applications and deliver exceptional audio experiences to your users. Download the updated SDK today and start making the most out of Unreal Engine 5.4!

Download ODIN SDK v1.8.7 Download the latest version of ODIN SDK v1.8.7 from our GitHub repository or directly from the Unreal Engine Marketplace. For more information on the ODIN SDK and its features, visit our official website.

Go to Unreal Marketplace

`}),e.add({id:3699,href:"https://www.4players.io/blog/4players-releases-odin-unreal-sdk-v1.8.2/",title:"Unleashing the Power of Seamless Communication: 4Players ODIN SDK v1.8.2 for Unreal Engine",section:"4Players Blog",description:"Discover the latest update to the 4Players ODIN SDK for Unreal Engine. Version 1.8.2 brings key improvements in compatibility and functionality.",content:`

The world of real-time communication in gaming and digital applications is constantly evolving, and staying ahead of these changes is crucial for developers. That’s why we’re thrilled to announce the release of version 1.8.2 of our ODIN Software Development Kit (SDK) for Unreal Engine, packed with enhancements that promise to elevate your development experience.

What’s New in v1.8.2?

Improved Plugin Compatibility: In our ongoing effort to ensure smooth integration with a wide range of Unreal Engine projects, we’ve renamed the odin.h core SDK header file. This change addresses and prevents naming conflicts with other plugins, ensuring a more streamlined development process.
Crucial Bug Fix: We’ve addressed a significant bug related to the BytesToString and StringToBytes functions in Unreal Engine, which previously disrupted the peer/room user data byte array format. This fix is based on detailed community feedback (see the forum post for more details). Our commitment to community-driven improvements continues to shape the ODIN SDK, making it more robust and developer-friendly.

Looking Back: v1.8.1 Enhancements

While we didn’t announce it separately, version 1.8.1 also brought a subtle yet impactful change:

Streamlined Codebase: We removed the unused ConstructJsonValue function. This refinement aligns with our philosophy of lean and efficient code, ensuring that every element of the ODIN SDK is essential and purpose-driven.

Why Choose 4Players ODIN SDK for Unreal Engine?

Our SDK stands at the forefront of real-time communication solutions, offering unparalleled voice communication integration into your digital applications. Whether you’re working on a gaming project, an educational platform, or a VR/AR application, the ODIN SDK empowers you with:

Cutting-edge technology for superior communication experiences.
Cross-platform compatibility, from desktop to mobile.
A focus on privacy and security, respecting user data.
Scalability to meet the needs of any project size.
Comprehensive documentation and support for effortless implementation.

Embark on Your Next Project with Confidence

We’re committed to providing developers with the tools they need to create immersive, interactive, and connected experiences. The release of ODIN SDK v1.8.2 for Unreal Engine is a testament to this commitment, reflecting our dedication to continuous improvement and responsiveness to community feedback.

Stay ahead in the dynamic world of application development with 4Players ODIN SDK. Download version 1.8.2 today, and experience the difference in your Unreal Engine projects.

`}),e.add({id:3700,href:"https://www.4players.io/blog/4players-releases-odin-unity-sdk-v1.6/",title:"Unity SDK v1.6.0: Elevating Your Development Experience with Core SDK v1.6.4 and Essential Fixes",section:"4Players Blog",description:"Discover the latest enhancements in Unity SDK v1.6.0, featuring Core SDK version 1.6.4 integration and key bug fixes.",content:`

In the world of game development and interactive applications, continuous improvement is key to creating outstanding user experiences. That’s why we’re excited to announce the release of Unity SDK version 1.6.0. This latest update encapsulates our commitment to providing developers with robust, efficient tools for integrating top-tier real-time communication features.

Core SDK Integration: A Leap Forward

Core SDK Version 1.6.4: The heart of this update lies in the integration of Core SDK version 1.6.4. This advancement brings with it a suite of enhancements and optimizations, ensuring that your Unity projects benefit from the latest developments in real-time communication technology.

Focused Bug Fixes and Improvements:

Serialization Build Error Resolution: In response to feedback from our developer community, we’ve addressed and fixed the potential FindObjectOfType serialization build errors. This fix significantly improves the build process, providing a smoother and more reliable development experience.
UserData Handling Optimization: Another crucial fix in this update is the resolution of an issue where user data was incorrectly replicated across multiple rooms when using OdinHandler.JoinRoom. This fix ensures that user data is handled accurately and securely, maintaining the integrity of room-based operations.

Implications for Developers:

The release of Unity SDK v1.6.0 marks a significant step in enhancing the efficiency and reliability of game development and interactive applications. By addressing key issues and integrating the latest Core SDK, we empower developers to focus on what they do best - creating immersive, interactive experiences without worrying about the complexities of real-time communication integration.

Join the Evolution:

Ready to take your Unity projects to the next level? Incorporate Unity SDK v1.6.0 into your development workflow today. Explore the detailed changelogs and begin leveraging these latest enhancements for a superior development experience. Visit our GitHub repository to download the update and start transforming the way you integrate communication in your applications.

Download the Unreal SDK today

`}),e.add({id:3701,href:"https://www.4players.io/blog/4players-hires-fullstack-developers-2023-12/",title:"Join Our Innovative Team at 4Players: Empowering the Future of Gaming and Communication",section:"4Players Blog",description:"Join 4Players as a Fullstack Engineer. Be part of a leading gaming company, shaping the future of gaming experiences. Apply now!",content:`

At 4Players, we’re not just about games; we’re about pushing the boundaries of digital interaction. As leaders in the game server business in Germany and pioneers in developing innovative 3-D communication technologies, we are continuously expanding our horizons into the realms of the Metaverse, VR, and immersive applications.

Who We Are Looking For: Full-Stack Developer (m/f/d)

Are you passionate about creating complex software solutions in a gaming environment? Do you have expertise in PHP, JavaScript/TypeScript, HTML5, CSS3, and backend technologies like REST APIs and MySQL? Then you might be the perfect fit for our team!

What We Offer:

Permanent position with 30 days of vacation per year
An exciting, dynamic work environment in the world’s largest entertainment industry
Flat hierarchies in a creative team
Flexible working hours with remote working options
Regular team events and more!

Your Role:

Develop and maintain customer frontends, websites, and backend systems
Take responsibility for new projects and redesign existing tools
Create technical documentation

Join Our Team:

Become a part of a team that thrives on flexibility, independence, and collaboration. Enjoy our modern structures, tools, and a relaxed working environment, where you’ll work with a diverse group of over 25 colleagues.

Ready to make an impact in the gaming world? Apply now!

Apply Now

`}),e.add({id:3702,href:"https://www.4players.io/blog/wwise-and-odin-for-unreal/",title:"Wwise and ODIN: how to integrate a voice chat into your Unreal game using both plugins",section:"4Players Blog",description:"Are you wondering if our proximity voice chat ODIN works together with Wwise? Yes, it does! We offer a guide and code examples here.",content:`

Wwise and ODIN

Are you using Unreal with Wwise and wondering if it works together with our proximity voice chat ODIN? Yes, it does! It’s not even hard to do. It needs a little different setup for the voice playback, though. After that you can take advantage of the high quality built-in features from Wwise and apply them to your voice audio, e.g. spatial audio.

Read our guide and check our sample project:

Wwise Guide

Sample Project

If you are new to ODIN, read this »Starter Guide« or watch our »Video Tutorial Series«

Using FMOD? We got you covered with this »Guide for FMOD«

Do you need help with another sound plugin or did you already find a solution to make it work with Odin? Please tell us on Discord !

Discord Community

`}),e.add({id:3703,href:"https://www.4players.io/blog/spread-holiday-joy-with-a-5-euro-gift-introducing-the-4netplayers-affiliate-hub/",title:"Spread Holiday Joy with a €5 Gift: Introducing the 4NetPlayers Affiliate Hub",section:"4Players Blog",description:"This holiday season, 4NetPlayers is delighted to introduce a gift that keeps on giving: the 4NetPlayers Affiliate Hub. ",content:`

Introduction

This holiday season, 4NetPlayers is delighted to introduce a gift that keeps on giving: the 4NetPlayers Affiliate Hub. It’s your opportunity to spread cheer and earn rewards with our exclusive Christmas promotion.

What is the 4NetPlayers Affiliate Hub?

The Affiliate Hub is our way of turning your gaming network into a lucrative venture. It allows you to share the joy of gaming with personalized €5 discount codes, and when your friends make a purchase, you earn too!

Your Personal €5 Discount Code

As a highlight of our Christmas campaign, we’re giving you the power to create individual €5 discount codes. These codes aren’t just a fantastic deal for your friends – they’re your ticket to earning money for every successful referral. It’s simple: the more your code is used, the more you earn.

Why Join the Affiliate Hub?

Rewarding Friendships: Your friends get €5 off their first purchase, and you get a commission. It’s a win-win!

Spread the Holiday Spirit: What better way to celebrate the season than by giving the gift of gaming at a great price?

Celebrate Earnings: Enjoy the festivities even more, knowing that each new player you bring to our community boosts your holiday budget.

How to Get Started

Ready to reap the rewards? Here’s what you need to do:

If you’re not already a 4NetPlayers member, sign up at Server Manager & Config-Interface.

Once registered, visit the 4NetPlayers Affiliate Hub to create your unique €5 discount codes.

Share them with your friends, family, and gaming buddies.

Conclusion

The 4NetPlayers Affiliate Hub is your chance to make the holiday season brighter for everyone. By sharing your personalized €5 discount codes, you’re not only giving the gift of gaming – you’re also setting yourself up for a prosperous new year. Start spreading the cheer (and earning your rewards) today!

`}),e.add({id:3704,href:"https://www.4players.io/blog/introducing-our-ai-powered-chatbot-for-odin-sdk-support/",title:"Introducing Our AI-Powered Chatbot for ODIN SDK Support – Your 24/7 Development Companion",section:"4Players Blog",description:"Available 24/7 for Unreal, Unity, and Web SDK queries, this innovative tool offers instant, comprehensive assistance, enhancing your development experience. ",content:`

Dear Developers,

We’re thrilled to announce an exciting addition to our ODIN Software Development Kit (SDK) resources – an AI-powered chatbot, designed to provide round-the-clock support for developers working with the ODIN SDK. This innovative tool is now accessible through our developer documentation at 4Players ODIN and is ready to assist with Unreal, Unity, and Web SDK queries. Swift SDK support is on the horizon as well.

Understanding the AI Chatbot

Our AI assistant is not just any chatbot. It’s been meticulously trained with extensive ODIN documentation, SDK references, guides, and sample code. This means that it’s equipped to offer detailed and specific support, mirroring the expertise you’d expect from our developer team.

Why Use the AI Chatbot?

24/7 Availability: Whether you’re burning the midnight oil or working in a different time zone, our AI chatbot is always on standby to help you out.
Instant Support: Get immediate answers to your queries without waiting for human support, enabling a smoother and faster development process.
Comprehensive Knowledge Base: With training based on our vast repository of ODIN documentation, the chatbot can handle a wide array of questions, from basic to complex.

Your Feedback Matters

As exciting as this beta release is, we acknowledge that perfection is a journey. That’s why we’re inviting you, our valued user community, to actively participate in this journey. Test out the chatbot and use the feedback buttons to rate answers as useful or not. Your input is crucial for us to continually refine and enhance the chatbot’s capabilities.

Continuous Improvement

We’re committed to making this AI chatbot an invaluable tool for developers. Based on your feedback and ongoing chats, we will constantly update its training material and fine-tune its responses, with the help of our experienced development team.

Future Plans

Expanding the AI chatbot’s support to include other SDKs is a priority for us. We’re working diligently to extend its capabilities so that no matter which part of the ODIN ecosystem you’re working with, expert assistance is always a chat away.

Get Started

Experience the future of developer support now. Head over to our ODIN documentation and start chatting with the AI assistant. We can’t wait to hear about your experiences and look forward to growing together in this exciting new chapter of development support.

Thank you for being a part of our community and for joining us in this innovative journey.

Happy Developing!

`}),e.add({id:3705,href:"https://www.4players.io/blog/4players-releases-odin-unreal-sdk-v1.8.0/",title:"ODIN Unreal SDK 1.8.0: New API Features and Critical Improvements",section:"4Players Blog",description:"We're proud to announce a new UE plugin version with important enhancements and new API features that further streamline your development process.",content:`

Hello ODIN Developers!

We are excited to bring you the latest update for the ODIN Unreal SDK - version 1.8.0. This release comes with important enhancements and new API features that further streamline your development process. Let’s delve into what 1.8.0 has to offer:

Core SDK Update

The core SDK has been advanced to version 1.6.4. This update is pivotal in ensuring that our SDK remains at the forefront of technology. You can find more details on this update here.

API Enhancements

RestartCapturing in UOdinAudioCapture: This new addition allows for a more flexible control over audio capturing, enabling developers to restart capturing with ease.
GetIsPaused and SetIsPaused in UOdinAudioCapture: These functions provide greater control over audio capture management, allowing for a pause and resume mechanism.

Bugfixes and Improvements

Unreal Engine 5.3 Compatibility: We’ve addressed build issues and deprecation warnings associated with Unreal Engine 5.3, ensuring smoother integration.
Crash Fix on Capturing Restart: Resolved a potential crash that could occur when trying to restart capturing after stopping it.
CanContainContent Disabled: In response to community feedback (as noted in issue #1), we’ve disabled CanContainContent, focusing on enhancing user experience.

Join Us in Shaping the Future

As always, your feedback is invaluable to us. It helps us tailor our SDK to meet your needs and expectations. We encourage you to dive into version 1.8.0 and share your thoughts with us.

Together, let’s continue to push the boundaries of real-time communication in game development!

`}),e.add({id:3706,href:"https://www.4players.io/blog/4players-releases-odin-unreal-sdk-v1.7.0/",title:"Introducing ODIN Unreal SDK 1.7.0: A Leap Forward in Real-Time Communication",section:"4Players Blog",description:"Discover the latest advancements in ODIN Unreal SDK with version 1.7.0, featuring input volume adjustment for capture media and critical improvements.",content:`

Hello ODIN Community!

We are excited to announce the release of ODIN Unreal SDK 1.7.0, marking a significant step forward in our commitment to providing the best real-time communication solutions. This release builds upon our previous updates in the 1.6.x branch, bringing new features and critical improvements. Let’s take a look at the journey from 1.6.1 to our latest 1.7.0 update:

1.6.1 & 1.6.2: Core SDK Updates and Stability Enhancements

Core SDK Progression: Both 1.6.1 and 1.6.2 versions focused on updating the core SDK, enhancing overall performance and stability. Detailed insights can be found here for 1.6.1 and here for 1.6.2.
1.6.2 Specific Improvements:
- Resolved build issues related to missing includes in Unreal Engine 5.3.
- Addressed a bug causing crashes with invalid reference handling during MediaRemoved events.
- Fixed potential crashes during seamless travel, ensuring smoother transitions and reliability.

1.6.3: Direct API Access and Bug Fixes

Enhanced API Functionality: Updated the API to allow direct access to the internal media sound generator, offering more control and flexibility.
Audio Capture Optimization: Fixed a bug where UAudioCapture was initialized with an invalid sample rate or channel count, ensuring more accurate audio processing.

1.7.0: A New Milestone with Enhanced Audio Control

Input Volume Adjustment: The highlight of version 1.7.0 is the addition of input volume adjustment functionality for capture media. This feature allows developers to fine-tune audio input levels, providing better control over the user experience in real-time communication scenarios.

Moving Forward Together

As we continue to evolve the ODIN Unreal SDK, we remain dedicated to enhancing your development experience. These updates reflect our commitment to addressing community feedback and advancing our technology.

We encourage you to explore these new updates and share your experiences. Your feedback is instrumental in guiding our future developments.

Thank you for being a part of our journey. Here’s to many more milestones with ODIN!

Download the Unreal SDK today

`}),e.add({id:3707,href:"https://www.4players.io/blog/introducing-odin-voice-unreal-sdk-1.6.1/",title:"Introducing Unreal SDK 1.6.1: New features, many bugfixes, some small API changes",section:"4Players Blog",description:"We are happy to announce the latest update to our Unreal SDK. It has new features along with many bugfixes and improvements, but also some small API changes.",content:`

Introduction

We are happy to announce the release of our Unreal SDK 1.6.1. This version brings new features and bugfixes, but also some small API changes.

What’s new in Unreal SDK 1.6.1 compared to 1.5.6 ?

General

The Core SDK has been updated to version 1.6.1.

New Features

Added Pause Playback Media to instruct the server to pause the specified media stream, ceasing the reception of data
Added Resume Playback Media to instruct the server to resume the specified media stream, re-initiating the reception of data
Added Get Output Media Peer ID
Added Set Room APM Stream Delay for scenarios where audio output and input are not synchronized to ensure that the echo canceller can align both streams

API Changes

Updated Join Room and Update Peer Position to support 3D coordinates
Removed Update Room User Data (use RoomUpdate RPC on an ODIN gateway instead)

Bugfixes / Improvements

Fixed build issues and deprecation warnings with Unreal Engine 5.3
Fixed a potential crash when switching capture devices
Added functions to allow listening to audio buffer changes in OdinMediaSoundGenerator
Update default build settings for compatibility with engine versions 4.24 or later
Updated include path in OdinMediaSoundGenerator
Fixed an issue where stereo output interfered with the functioning of echo cancellation
Updated initial APM settings
- Enabled Voice Activity Detection
- Enabled Noise Suppression
- Enabled Gain Controller
Updated static library format on iOS and macOS for Unreal Engine Marketplace compliance
Fixed a bug where capture device selection always picked the default device

Conclusion

The Unreal SDK 1.6.1 brings convenience and bandwidth saving features along with many bugfixes and improvements. Upgrade to Unreal SDK 1.6.1 today and benefit from the new improvements in your projects. We look forward to your feedback and to continually refining our SDKs for your needs.

Download Odin Voice SDK 1.6.1
ODIN SDK @ Unreal Marketplace (update available soon!)
Join our Discord
Read the Documentation

`}),e.add({id:3708,href:"https://www.4players.io/blog/4players-releases-odin-unreal-sdk-v1.6.0/",title:"Unveiling New Enhancements: ODIN Unreal SDK Update from 1.5.6 to 1.6.0",section:"4Players Blog",description:"Explore the latest updates in ODIN Unreal SDK 1.6.0, featuring advanced media stream control, enhanced audio processing, and full compatibility with Unreal Engine 5.3",content:`

Greetings, ODIN Developers!

We are excited to share the latest updates to our ODIN Unreal SDK, covering the advancements from version 1.5.6 to the newly released 1.6.0. This update marks significant improvements and new features that will enhance your development experience. Let’s dive into the details:

1.5.7: Streamlined Compliance and Device Selection

Browser Clients Update: It’s important to update your browser clients to version 0.15.0 or later of the @4players/odin package.
Core SDK Update: Upgraded to version 1.5.7. Check the details here.
iOS and macOS Enhancements: We’ve updated the static library format for better compliance with Unreal Engine Marketplace standards.
Capture Device Selection Fix: Resolved an issue to ensure the correct capture device is selected, rather than defaulting to the system’s choice.

1.5.8: Advanced Audio Processing and Echo Cancellation

Core SDK Update: Progressed to version 1.5.8. Full details are available here.
New Features:
- Set Room APM Stream Delay: This feature assists in syncing audio output and input, vital for effective echo cancellation.
Stereo Output and Echo Cancellation: Fixed a crucial issue where stereo output was impacting echo cancellation.
APM Settings Update: We’ve enabled Voice Activity Detection, Noise Suppression, and Gain Controller for optimized audio processing.

1.5.9: Audio Buffer Enhancements and Engine Compatibility

OdinMediaSoundGenerator Updates: Added functions for monitoring audio buffer changes and updated include paths for improved usability.
Engine Compatibility: Ensured default build settings are compatible with Unreal Engine versions 4.24 and later.

1.6.0: Pioneering Media Stream Control and API Enhancements

Server Requirements: This update necessitates ODIN server version 1.3.0 or newer. Cloud-hosted servers are updated automatically.
Core SDK Update: Advanced to version 1.6.0. Full release notes can be found here.
New Features:
- Pause Playback Media & Resume Playback Media: These commands allow for precise control over media stream reception.
- Get Output Media Peer ID: A new addition for enhanced media stream management.
API Updates:
- Join Room and Update Peer Position now support 3D coordinates.
- Update Room User Data has been removed in favor of the RoomUpdate RPC.
Compatibility and Stability Improvements: Fixed build issues and addressed deprecation warnings with Unreal Engine 5.3. Also resolved a potential crash related to capture device switching.

Join Us in This Exciting Journey

These updates represent our commitment to providing you with a robust and efficient development environment. We encourage you to explore these new features and improvements. Your feedback is invaluable in our quest for continuous enhancement.

Stay tuned for more updates, and happy developing with ODIN!

Download the Unreal SDK today

`}),e.add({id:3709,href:"https://www.4players.io/blog/introducing-odin-voice-unreal-sdk-1.5.6/",title:"Introducing Unreal SDK 1.5.6: Expanding iOS Support and Enhanced Stability",section:"4Players Blog",description:"We're proud to announce the latest update to our Unreal SDK, including iOS support, new features, and improved system stability.",content:`

Introduction

We are thrilled to announce the release of our Unreal SDK 1.5.6. This version brings robust support for iOS, various new features, significant improvements in system stability, and compatibility for upcoming Unreal Engine 5.3 releases.

What’s New in Unreal SDK 1.5.6?

General

The Core SDK has been updated to version 1.5.5.
We’ve now switched to static linking on iOS and macOS, making your development process more streamlined.

New Features

iOS Support: We have expanded our platform reach to include iOS, enabling more users to experience high-quality voice communication.
Reset Function: The new Reset function resets media handles on ODIN synth components, offering greater control over media handling.
Room User Data Changed Event: The SDK now broadcasts a ‘Room User Data Changed’ event, providing real-time information about changes in user data.
Support for Unreal Engine 5.3: We are ensuring your projects stay ahead of the curve with support for the upcoming Unreal Engine 5.3 releases.

Bugfixes / Improvements

Unreal Engine Build Issues: Fixed potential build issues with Unreal Engine 5.1 and later.
Garbage Collection of Handles: Resolved an issue where handles were unexpectedly garbage collected, resulting in closed connections.
Invalidated Structures Access: Fixed issues causing application crashes due to accessing pointers linked to invalidated structures.
Asynchronous Access Violations: Resolved crashes resulting from asynchronous access violations.
Game-Thread Synchronization: Enhanced system stability by wrapping each event with game-thread synchronization tasks.
Event Handling Update: Event handling now uses task-launching on a per-event basis, offering more efficient processing.
AVAudioSession Configuration: To mitigate potential crash issues on iOS, we’ve ensured the proper configuration of AVAudioSession.
Linker Issues: Fixed linker issues caused by the use of a newer clang version in Unreal Engine 5 projects.

Conclusion

The Unreal SDK 1.5.6 brings significant enhancements and expanded platform support, ensuring a more robust voice communication experience for users across various platforms. Upgrade to Unreal SDK 1.5.6 today and benefit from the new features and stability improvements in your projects. We look forward to your feedback and to continually refining our SDKs for your needs.

`}),e.add({id:3710,href:"https://www.4players.io/blog/4players-releases-odin-unity-sdk-v1.5.5/",title:"Announcing Unity SDK 1.5.5: Enhanced Audio Performance and Android Support",section:"4Players Blog",description:"Introducing the latest update to our Unity SDK, featuring new features, improved audio handling, and Android ARMv7a support.",content:`

Introduction

We are excited to announce the release of our Unity SDK 1.5.5. This new update brings improvements to the audio handling, bug fixes, and support for Android on ARMv7a devices, ensuring a seamless and high-quality voice communication experience across multiple platforms.

What’s New in Unity SDK 1.5.5?

General Update

The Core SDK has been updated to version 1.5.5. For more detailed information on the core updates, please refer to the Core SDK release notes.

New Features

Android ARMv7a Support: We’ve broadened our Android device support with the inclusion of ARMv7a, expanding the reach of your voice communication capabilities to even more users.

API Changes

SilenceCapturedAudio Addition: We’ve introduced the SilenceCapturedAudio method on the audio sender, giving you more control over the audio capture process.
Deprecated Properties Removal: To streamline our API, we’ve removed the IsPaused and IsMuted deprecated properties from media streams.

Bugfixes and Improvements

Device Reset Fallback: To ensure smoother recovery, we’ve added a fallback to the default device during reset.
OnMediaActiveStateChanged Event Update: We’ve fixed the update for this event for input streams, ensuring accurate status updates.
Echo Cancellation: Echo cancellation has been improved for enhanced audio clarity during conversations.
PlaybackStream Connection Reset: We’ve ensured that the media handle resets upon connecting to the PlaybackStream for a clean state.

Conclusion

Our Unity SDK 1.5.5 brings significant improvements to audio handling and broadens device support, ensuring a more robust and inclusive voice communication experience for users across various platforms. We are committed to continuous refinement of our SDKs and look forward to hearing your feedback.

Upgrade to Unity SDK 1.5.5 today and unlock enhanced voice communication features in your projects!

Join the Ghosts of Tabor Discord Server

`}),e.add({id:3711,href:"https://www.4players.io/blog/we-are-hiring-june-2023/",title:"We're Hiring: Join Our Team as a Senior Sales Manager for Videogame Services!",section:"4Players Blog",description:"Join 4Players as a Senior Sales Manager for Videogame Services. Be part of a leading gaming company, shaping the future of gaming experiences. Apply now!",content:`

Hello, 4Players community!

We are thrilled to announce an exciting opportunity to join our team. We are currently looking for a dedicated and experienced Senior Sales Manager for Videogame Services to support our growing team and market our high-quality products and services in the B2B sector.

About 4Players

4Players is a leading company in the gaming industry, developing social and immersive gaming experiences for over 20 years. As pioneers in the industry, we have shaped the evolution of gaming and now offer state-of-the-art, metaverse-ready solutions for developers and gamers. Our main product, ODIN, is a top-tier, cross-platform voice chat tool that seamlessly integrates into game engines like Unity and Unreal. We also provide high-quality hosting services adaptable to all requirements and budgets.

Your Role

As a Senior Sales Manager, you will be responsible for:

Establishing and maintaining contact with B2B companies in the video game industry and companies interested in innovative and digital solutions from other industries.
Acquiring new customers and partners for existing and future 4Players products and services.
Building and maintaining B2B Key Accounts.
Managing contacts and customers in our CRM system.
Networking and relationship management with relevant customers and strategic partners.
Market and competition observation.
Supporting the further development of business models, market launch strategies, and action plans in collaboration with local innovation or project management teams.
Budget planning and responsibility.

Your Profile

We are looking for someone with:

A successful commercial education or degree in sales, marketing, economics, or a similar field.
At least 2-3 years of professional experience in sales, preferably in the gaming, software, or technology industry.
Strong customer and service orientation, negotiation skills, and persuasiveness.
Willingness to travel for customer visits, trade fairs, and events.
Basic knowledge of CRM systems and common office programs.
Organizational talent, able to work on several projects simultaneously.
Proficiency in German and English.
A passion for gaming.

What We Offer

An unlimited permanent position.
A dynamic and exciting working environment.
Flat hierarchies in a committed and creative team.
Work in the world’s largest entertainment industry (PC and video games).
Responsibility for your own projects.
Flexible working hours with home office option in a hybrid model.
30 days of vacation.
Regular team events.
Lots of fun and joy at work.
Sweets and snacks for everyone in the office.

If you are passionate about gaming and technology and want to be part of an innovative company shaping the next generation of gaming experiences, we invite you to join our dynamic and future-oriented company.

We look forward to your application!

Apply Now

`}),e.add({id:3713,href:"https://www.4players.io/blog/introducing-the-odin-nodejs-sdk-unlock-server-side-capabilities-for-voice-communication/",title:"Introducing the ODIN Node.js SDK: Unlock Server-Side Capabilities for Voice Communication",section:"4Players Blog",description:"Discover our new Node.js SDK, enabling advanced server-side functionality like voice recording, transcription, and building bots for immersive in-game experiences",content:`

Introduction

We are proud to announce the availability of our native Node.js SDK for ODIN, expanding the possibilities for server-side voice communication in your projects. This powerful new SDK allows developers to access advanced features like recording and transcribing voice per user, building bots that interact with other users through text chat or voice, and more. By leveraging the native Node.js bindings for the ODIN SDK, you can unlock the full potential of voice communication in your games and applications.

ODIN Node.js SDK Overview

The ODIN Node.js SDK is based on the ODIN Native SDK and wraps the C++ code into a Node.js module. While we offer a JavaScript/TypeScript SDK with fallback code for WebRTC that can be used in browsers and Node.js, it is not as performant and has some limitations. The native Node.js SDK addresses these issues and provides additional functionality, making it the perfect choice for bots and other advanced use cases.

Key Differences between ODIN Node.js SDK and Web SDK

While the API for the Node.js SDK is designed to be as similar as possible to the Web SDK, there are some differences:

The Node.js SDK allows you to access raw audio data from the ODIN server, enabling you to record audio or send audio into a room.
The Node.js SDK is optimized for server-side use cases, while the Web SDK is tailored for browser-based applications.

Prerequisites and Dependencies

To use the ODIN Node.js SDK, you will need a C++ compiler installed. For macOS, install XCode and the command line tools; for Linux, install GCC. More information on this can be found in the node-gyp documentation.

The ODIN Node.js SDK depends on the native ODIN SDK. Some precompiled libraries for typical platforms (macOS, Windows, and Linux) are provided in the libs folder.

Usage Examples

We have created two simple usage examples that you can find in the tests folder of the NPM package.

Audio Recording and Transcription

We provide an example that demonstrates how to use the ODIN Node.js SDK to record audio from other users and send it to OpenAI for transcription using OpenAIs whisper model. It also showcases basic bot functionality, such as sending a message to the chat.

Sending Music

This example demonstrates how to use the ODIN Node.js SDK to send music to other users in a room. It loads a sample MP3 file, decodes it, and sends it to the ODIN server.

Detailed instructions on how to run the music sending example can be found in the tests/sending-audio folder of the NPM package.

Conclusion

The ODIN Node.js SDK opens up a world of possibilities for server-side voice communication, providing advanced functionality for developers to create immersive and interactive experiences. With the native Node.js bindings, you can harness the power of the ODIN SDK and bring your projects to new heights.

Get started with the ODIN Node.js SDK today and explore the incredible potential of server-side voice communication in your applications!

ODIN Node.js SDK on NPM

`}),e.add({id:3714,href:"https://www.4players.io/blog/introducing-odin-voice-sdk-1.5.0-enhancing-3d-spatial-voice-communication-for-unreal-engine-games/",title:"Introducing ODIN Voice SDK 1.5.0: Enhancing 3D Spatial Voice Communication for Unreal Engine Games",section:"4Players Blog",description:"Discover our latest update with new features, Unreal Engine 5.2 support, and bugfixes to elevate your in-game voice communication experience",content:`

Introduction

We are excited to announce the release of ODIN Voice SDK 1.5.0, a significant update to our real-time voice SDK for Unreal Engine-based games. This new version delivers enhanced 3D spatial voice communication, making it even easier for developers to add immersive and realistic voice interactions in their games. With full blueprint support and a range of new features and bugfixes, ODIN Voice SDK 1.5.0 promises to take in-game communication to the next level.

What’s new in ODIN Voice SDK 1.5.0

General

Our core SDK has been updated to version 1.5.0, incorporating a range of improvements and optimizations. For a detailed breakdown of the changes, please refer to our official documentation.

New Features

Unreal Engine 5.2 Support We’re proud to offer support for Unreal Engine 5.2, ensuring that developers can access the latest features, optimizations, and capabilities of this powerful game engine.
Reverse Stream Processing for Echo Cancellation To provide an even clearer communication experience, we’ve added reverse stream processing for echo cancellation. This feature uses the engine master submix to minimize echo and improve overall audio quality.
UOdinAudioCapture Class for Capture Device Selection With the addition of the UOdinAudioCapture class, developers can now enable users to choose their preferred audio capture device, providing a more seamless and customizable experience.

Bugfixes / Improvements

Audio Attenuation Settings Fix We’ve fixed a bug where audio attenuation settings were not being applied correctly, ensuring that distance-based audio adjustments work as intended.
Active Media Stream Objects Garbage Collection Fix We’ve addressed an issue where active media stream objects were being garbage collected, leading to unexpected behavior. This fix ensures more stable and reliable voice communication.
Blueprint Only Builds on Linux Fix Developers working on Linux can now rejoice as we’ve resolved the issue with blueprint-only builds, making it easier to develop and deploy projects across platforms.

Conclusion

ODIN Voice SDK 1.5.0 is a major milestone in our journey to provide the best possible 3D spatial voice communication for Unreal Engine-based games. This update brings new features, performance improvements, and bugfixes that will help developers create even more immersive and engaging in-game experiences.

We’re committed to continuously improving and expanding our SDK, and we can’t wait to see the incredible projects our community will build using these new capabilities. Don’t hesitate to share your feedback and experiences with us, as we value your input in shaping the future of ODIN Voice SDK.

Get started with ODIN Voice SDK 1.5.0 today and elevate your in-game voice communication like never before!

`}),e.add({id:3715,href:"https://www.4players.io/blog/introducing-web-sdk-0151-enhanced-cross-platform-interoperability-for-real-time-voice-communication/",title:"Introducing Web SDK 0.15.1",section:"4Players Blog",description:"Discover the latest update to our Web SDK, enabling seamless voice communication between web and native platforms with our latest native SDKs",content:`

Introduction

We are thrilled to announce the release of Web SDK 0.15.1, a crucial update that enhances cross-platform interoperability with our latest native SDKs, starting with version 1.4.0 or later. This new version addresses important bugfixes and introduces updated QoS metrics for compatibility, ensuring a seamless voice communication experience between web and native platforms.

What’s new in Web SDK 0.15.1

Bugfixes

Speech Detection Settings in VAD Processor: We’ve fixed a bug where speech detection settings were not being applied correctly in the Voice Activity Detection (VAD) processor. This fix ensures accurate speech detection and a better overall voice communication experience.

Improvements

Updated QoS Metrics for Native Client Compatibility: In this update, we’ve made changes to the Quality of Service (QoS) metrics to ensure compatibility with native clients using version 1.4.0 or later. This improvement guarantees smooth interoperability between web and native platforms, providing a consistent and high-quality voice communication experience for all users.

Conclusion

Web SDK 0.15.1 is a significant step forward in ensuring seamless cross-platform voice communication, allowing developers to create engaging and immersive experiences for users across web and native platforms. This update provides important bugfixes and compatibility improvements, making it easier than ever to connect players and create collaborative gaming experiences.

We are committed to continually refining and expanding our SDKs, and we look forward to seeing the innovative projects our community will develop using these new features. Your feedback is invaluable to us, and we encourage you to share your thoughts and experiences with our team.

Upgrade to Web SDK 0.15.1 today and unlock the full potential of cross-platform voice communication in your projects!

`}),e.add({id:3716,href:"https://www.4players.io/blog/announcing-partnership-with-combat-waffle-studios/",title:"Announcing Partnership with Combat Waffle Studios",section:"4Players Blog",description:"ODIN supports voice chat in Ghosts of Tabor with 3D spatial audio, proximity chat, environmental effects and audio occlusion.",content:`

We are excited to announce our partnership with Combat Waffle Studios Inc, who will be launching their latest game - Ghosts of Tabor - on 20th March 2023. Ghosts of Tabor is a VR-only survival game that promises to set new standards for immersion, putting you in the heart of a first-person military shooter.

The game takes place on the island of Tabor, where players must explore, loot, and shoot their way through the environment to survive. With crystal clear voice chat, you can coordinate with your friends to overcome the challenges that lie ahead. And with ODIN’s support, voice chat in Ghosts of Tabor will feature 3D spatial audio, proximity chat, environmental effects and audio occlusion, making the gameplay experience all the more immersive.

With its stunning graphics, realistic sound effects, and adrenaline-pumping gameplay, Ghosts of Tabor is sure to provide an unforgettable experience for gamers. So put on your VR headset and get ready for an adventure like no other. Combat Waffle Studios Inc has been working tirelessly to bring Ghosts of Tabor to life and we are proud to be partnering with them to provide our support. We believe that their innovative approach to VR gaming will be a game-changer in the industry and we look forward to seeing the impact that it will have.

As 4Players, we are committed to providing the best audio solutions for gaming with ODIN, so we are thrilled to be part of Ghosts of Tabor’s launch. We can’t wait to hear from the players about their experiences and how they fought their way through the island of Tabor.

In conclusion, if you’re a fan of survival games, first-person shooters, and immersive VR experiences, you won’t want to miss Ghosts of Tabor. Get ready to explore, loot, and shoot your way to survival, and don’t forget to let us know how you fared!

`}),e.add({id:3717,href:"https://www.4players.io/blog/announcing-partnership-with-specpixel-entertainment/",title:"Announcing Partnership with SpecPixel Entertainment",section:"4Players Blog",description:"4Players partners up with game developer SpecPixel Entertainment to support their game New Citizen.",content:`

Today, we’re thrilled to announce our exciting new partnership with SpecPixel Entertainment, in which we will be supporting their latest game - New Citizen - with our state-of-the-art ODIN in-game voice chat and high-performance servers from 4Netplayers!

New Citizen is the highly anticipated RPG multiplayer sim revival set to launch in 2023, and we can’t wait for you to experience this immersive and exciting new world. Whether you choose to explore alone or join a community, you will have the freedom to decide your own path. Will you be a hero, defending your city against the forces of evil, or will you rise through the ranks of the criminal underworld to become a powerful leader? The possibilities are endless!

Our ODIN in-game voice chat and 4Netplayers servers are designed to enhance your multiplayer gameplay experience, providing you with seamless and immersive communication with other players in real-time. With our cutting-edge technology, you’ll feel like you’re truly a part of this thrilling new world.

Check out the latest trailer for New Citizen right here:

To stay up to date with all the latest news and updates on New Citizen, be sure to join their brand new Discord server. Don’t miss out on the chance to experience the game in full immersion mode and become a part of this exciting new community. We’re honored to be a part of this partnership and can’t wait to see what the future holds!

Join the New Citizen Discord Server

`}),e.add({id:3725,href:"https://www.4players.io/blog/visualizing-occlusion-in-unity/",title:"Visualizing occlusion in real-time in Unity",section:"4Players Blog",description:"We wanted to visualize our 3D audio occlusion system for real-time voice in a video. Here is what we came up with and how we implemented it in Unity.",content:`

As you may have noted, we have been at a lot of events recently, all around the world. Games Convention in Cologne in August, Scottish Games Week, Megamigs in Montreal, and recently we were at the G-Star in South Korea. In all of these conventions we had a booth and showcased our real-time voice SDK ODIN. Users could enjoy one of our demos in real-time and talk to each other enjoying the 3D spatial audio.

But, it’s 2022, and we still face the same issues and hurdles we faced 10 years ago when attending conventions: Bad internet connection. Although we are able to run the whole ODIN stack on a laptop (i.e. the server and the client running on the same machine without requirement of internet connection) the experience is not as great as you just talk to someone standing next to you.

So, we decided to create a video to show-off what ODIN is all about and what 3D spatial audio is. It’s easier to run a video on a booth and having on-demand demos after the show rather than trying to do everything in a loud, internet-less, crowded environment that is a convention.

Here is the video we came up with:

A very important part of ODIN is its effortless 3D spatial audio system with audio occlusion. So, what does that mean:

If you are standing next to someone, you hear them loud and clear.
If you are standing behind someone, you hear them less loud.
If you are standing behind a wall, you hear them even less loud or you don’t hear them at all, depending on thickness and material of the wall.
If someone stands right next to you, you’ll hear them on your right ear
If someone walks away volume decreases with the distance until you don’t hear them anymore.

So, it’s basically a simulation of voice chatting in the real world. You can hear people around you as you would in real world. Of course, however with all the benefits of a digital, software driving simulation. You can work out the benefits and reduce the caveats.

We believe, that especially in experiences with a lot of people enjoying it at the same time. In a separate voice-chat application, you need to manage channels, people need to be in the right channels, they should be muted when not talking, etc. With ODIN, you don’t need to worry about any of that. You just join a room, and you can literally talk to anyone by just coming close. You can build separate spaces using our audio occlusion system to make sure they can have one-on-one meetings that are private. Of course, you don’t need to use the 3D spatial audio. You can also use radio like voice chat, where you can talk to everyone in the room at the same time always in full volume and without occlusion. It’s up to you, but that 3D spatial audio system sometimes needs some explanation, like I did in the last paragraphs. The video should just show that without many words.

Preparing the video

When creating a video, it’s always important to have a good idea of the goal. In this case, we had these goals:

Visualize audio volume fall-off (i.e. full volume close and silent “far” away)
Visualizing the nature of voice
Visualize audio occlusion
Make users hear the voice of the person simulated in the video

We came up with this idea to achieve these goals:

We have a simple scene in a Tron-style like look & feel
Our player (i.e. the player that “simulates” the viewer of the video) is located at the bottom center of the screen.
Another player is running around and talking at the same time
A few cubes are distributed around our scene acting as walls dampening the sound if between the player and the listener.
We try to visualize the audio and audio effects

We quickly decided to build the video in Unity as it gives as the possibility to provide an interactive demo via WebGL, and we don’t need to fake audio occlusion by putting tons of audio volume key frames in a video editor like Final Cut of Adobe Premiere. Instead, we just fired up Unity and our ODIN Unity SDK and just recorded a real-time editor session using the Unity Recorder. You can experience the demo in real-time by downloading the source-code from Github.

We also used our Audio Occlusion system that is part of our Unity demo. This will be bundled in the next version together with the Unity SDK. I had to copy a few files from the demo into my own project to make Audio Occlusion work. We attached the OcclusionAudioListener script to the listener player at the bottom of the screen and attached AudioObstacle script to the cubes with various different AudioEffectDefition assets like concrete, and fully silence.

As we wanted to create a self-running demo that we could record we used the character of Unitys Third Party Controller demo and created a simple waypoint system feeding the direction to the next waypoint as “joystick” inputs. The waypoints have a small box collider as trigger. Whenever our character gets triggered we select the next waypoint and navigate to that.

Info

One important thing to remember. In Unity you have the Audio Listener component that is typically attached to the main camera. In our scene, the main camera is located way above our third person character. So, we need to attach the Audio Listener to the player standing in the bottom center of the screen as he should be listening to the voice in the scene, not the camera.

Visualizing audio volume fall-off

One of the key principles of 3D audio is that there is a relation between the distance and the volume, i.e. if you are far away from the audio source you here it less loud. Unity has a “fall-off” setting that you lets you adjust in detail how this works. Here is an image of the settings of the Audio Source:

What that means is, that if you are close the audio source plays with full volume, linearly decreases to 0% volume in 5 units. It’s basically the same as a point light that attenuates over distance until it has no effect.

To do that, we created these game objects within Unity:

Player (center of the player)
- Plane (with our audio visualization shader and materials)

We also created a transparent Shader Graph shader and a material. The new shader and material will be used to visualize the audio volume of the simulated player, and it’s attached to the plane.

The plane has a standard scale of 1,1,1 and therefore is 10 units long and 10 units wide and thus extends 5 units from center. As you may have noticed, we set the audio falloff to 5 units, so that’s a good fit. Our plane is large enough to visualize the audio volume fall-off.

This is the simple Shader Graph for this shader and what it looks like:

The shader is very simple. It just takes the distance from the center of the plane and maps it to a color. What we do here is taking the point in object space. We can do that, as the plane is not scaled, and we don’t plan to rotate it. However, of course you could also take the sample point in world space and subtract it from the planes center. This would make things more complicated and for our needs that works great. Once we have the distance to the planes center which is the radius of the audio circle we can multiply it through the radius - which we provide via material variable radius which we set to 5 to be corresponding with the planes width and the fall-off settings of the Audio Source. Calculating the On Minus of that value we have a nice alpha value which is 1.0 in the center of the plane and linearly falls-off to 0.0 at the radius of the audio circle which is also the outer edge of the plane.

Visualizing the nature of voice

Still a little boring. We want to make sure that users watching the video immediately get the idea of the video, showing audio waves and not a nice implementation of a point light or a “fog of war”. I wanted to simulate audio waves moving like waves from the center of the circle to the outside. First, I experimented with a sinus wave and a time variable. That did look quite ok, but it has been missing the dynamics of voice which has ups and downs infrequently as shown in this waveform of a piece of voice saying something:

As you notice, the waveform looks a lot like a mirrored heightmap and this is exactly what we need. What we do is this:

Sample audio in real-time and create a heightmap of the audio. Loud pieces will be white, while silent pieces will be black.
Feed that shader into the shader to visualize the audio ripples.

How do we do that:

Create a texture of 128x1 and make it writable.
Create an array of floats of size 128 that will hold the heightmap (you’ll see later why)
Every few frames
- move the texture by one pixel to the right - this will create the impression of waves moving to the outside
- sample the current audio loundness in the range of 0.0 to 1.0 and write it to the texture at position 0,0

So, why creating an array of floats which is duplicate of what we already have in the texture? The reason is simple: Because as we want to move the pixels by one in the memory it would require us to read from the texture and moving this array by one, writing it back. I thought that reading from textures is slow, reading from memory is fast. So we build the texture in memory and just write the pixels to the texture.

Info

I also experienced with changing UVs on the texture rather that moving pixels. While this is getting a bit smoother animations, in the end it’s more complicated especially at the texture bounds that I rather concentrated on getting the video done rather than optimizing the shader. Perhaps that is good exercise for you.

Here are a few snippets:

AudioVisualizer script

public class AudioVisualizer : MonoBehaviour
{
    public AudioVisualizerPlane plane;
    public AudioVisualizerRenderOcclusion occlusionRenderer;
    public bool sampleAudio = true;
    public float loudnessScale = 10.0f;
    public int sampleDataLength = 100;
    public AudioSource audioSource;
    public Transform followObject;
    
    public Texture2D voiceTexture;
    private Color[] loundness = new Color[128];
    private float nextUpdate = 1.0f;
    private float[] clipSampleData;

    private void Awake()
    {
        if (!voiceTexture)
        {
            voiceTexture = new Texture2D(128, 1, TextureFormat.RGB24, false);
        }
        
        for (var i = 0; i < 128; i++)
        {
            loundness[i] = Color.black;
        }

        if (!audioSource)
        {
            audioSource = GetComponent<AudioSource>();

            if (!audioSource)
            {
                Debug.LogError("Voice Texture needs to have an AudioSource assigned or must be part of the Component");
            }
        }
        
        clipSampleData = new float[sampleDataLength];
    }

    private void Start()
    {
        if (!plane)
        {
            plane = GetComponentInChildren<AudioVisualizerPlane>();
            if (!plane)
            {
                Debug.LogError("You need to create a plane as children and assign the AudioVisualizerPlane component to it");
            }

            if (sampleAudio)
            {
                var renderer = plane.GetComponent<Renderer>();
                renderer.material.SetTexture("_RippleTexture", voiceTexture);                
            }
        }
        
        UpdateTexture();
    }

    private void UpdateTexture()
    {
        voiceTexture.SetPixels(0, 0, voiceTexture.width, 1, loundness);
        voiceTexture.Apply();
    }

    private void Update()
    {
        if (followObject)
        {
            transform.position = followObject.transform.position;
        }
        
        if (!sampleAudio) return;
        
        //if (Math.Truncate(Time.time) % 500 != 0) return; 
        if(Time.time>=nextUpdate){
            //Debug.Log(Time.time+">="+nextUpdate);
            // Change the next update (current second+1)
            nextUpdate=Time.time+0.025f;
            // Call your fonction
            SampleAudio();
        }
    }

    private void SampleAudio()
    {
        // Move audio out
        for (var i = 127; i >= 1; i--)
        {
            loundness[i] = loundness[i-1];
        }

        var loudness = SampleLoudness() * loudnessScale;
        //float loudness = Random.Range(0.0f, 1.0f);
        loundness[0] = new Color(loudness,loudness, loudness);
        
        UpdateTexture();
    }

    private float SampleLoudness()
    {
        audioSource.clip.GetData(clipSampleData, audioSource.timeSamples); //I read 1024 samples, which is about 80 ms on a 44khz stereo clip, beginning at the current sample position of the clip.
        var clipLoudness = 0f;
        foreach (var sample in clipSampleData) {
            clipLoudness += Mathf.Abs(sample);
        }
        clipLoudness /= sampleDataLength; //clipLoudness is what you are looking for
        
        return clipLoudness;
    }
}

Sampling audio gives you quite small float values. I used a scale of 10.0f to make it more visible. As we create the average audio volume of all samples we need to make sure that the number of samples is too large as the whole thing blurs too much. A good value for this visualizing has been 100 samples.

This is what the texture looks like:

Looks great, doesn’t it? And the ripples move from left to right. We feed it into our shader. Back in Shader Graph we need to make use of that texture:

We already have a value from 0.0 to 1.0 indicating the radius ratio from the center to the outside, meaning that we are close to the center at 0.0 and close to the outside at 1.0.
Remember that ripple texture with the hightmap moving from left to write. Well, our radius ratio is the x coordinate of the texture.
So, this is basically the u of the texture sample vector. We just feed that value in the texture sampler and multiple that value (which is from 0.0 to 1.0) with a color of the ripples.
We put that value in the emission slot of our fragment shader

That’s it. Looks great, doesn’t it:

Visualizing audio occlusion

We have a pretty cool video already with a player running around a scene, and you can hear the direction of the other player and when a cube is between both players that audio is silent or less loud. And we have a nice circular plane visualizing audio ripples and fall-off. But, we also wanted to visualize audio occlusion. What that means is, that we want an “audio-shadow” to be casted by the cubes.

I try to explain my solution to that in this ugly, little scribble:

This scribble shows our player position in the center of the plane and the audio occluders (which are cubes) around it. In orange is our audio circle around the center of the plane. However, there are areas of that circle that are red, which lie in the shadow of the audio occluders. Audio will not get to this point, because they are blocked by the occluders. The green dots and lines show places where audio can travel to, the have direct line of sight to the center of the plane. The purple dots haven’t got a direct line of sight, as the center of the plance is blocked by the occluders.

How do we know if an occluder is blocking the audio at a specific location on our plane and within our shader? The solution I came up with is a custom 360° depth buffer around the center of our plane holding the distance to occluders. In our shader we can sample that depth buffer and check if the distance to the occluder is smaller than the distance of our point on the plane. If that is the case, we know that the occluder is blocking the audio at that point and don’t render anything. If not, we can render our audio circle with the fall-off and audio ripples as we did before.

Creating the distance buffer

As discussed before, we need to have a 360° depth buffer with the distance between the occluder and the center of the plane. We can use Unitys APIs to render a camera into a cubemap, which will give us exactly what we want, as we can sample that cubemap very easily in our shader. Of course, we only got 50% of what we need, as a normal rendering of the scene will not help us. First, we put a camera as a child to our Player game object. Our hierarchy will look like this:

Player (center of the player)
- Occlusion Camera
- Plane (with our audio visualization shader and materials)

We create a new script and attach it to our occlusion camera:

AudioVisualizer script

public class AudioVisualizerRenderOcclusion : MonoBehaviour
{
    // Attach this script to an object that uses a Reflective shader.
    // Real-time reflective cubemaps!

    bool oneFacePerFrame = false;
    Camera cam;
    public RenderTexture cubemap;

    public int textureSize = 128;

    private void Awake()
    {
        cam = GetComponent<Camera>();

        if (!cubemap)
        {
            cubemap = new RenderTexture(textureSize, textureSize, GraphicsFormat.R32_SFloat, GraphicsFormat.D32_SFloat_S8_UInt);
            cubemap.dimension = TextureDimension.Cube;
        }
    }

    void Start()
    {
        // render all six faces at startup
        UpdateCubemap(63);
    }
    
    void LateUpdate()
    {
        if (oneFacePerFrame)
        {
            var faceToRender = Time.frameCount % 6;
            var faceMask = 1 << faceToRender;
            UpdateCubemap(faceMask);
        }
        else
        {
            UpdateCubemap((int)CubemapFace.PositiveX | (int)CubemapFace.NegativeX | (int)CubemapFace.PositiveZ | (int)CubemapFace.NegativeZ); // all six faces
        }
    }

    void UpdateCubemap(int faceMask)
    {
        //if (!cubemap) return;
        
        
        cam.RenderToCubemap(cubemap, 51);
    }
}

We create a new RenderTexture and set it to a cubemap. We set the format to R32_SFloat as one float channel for the distance data is enough. Every frame we either render all faces or only one frame per frame to save performance. Depending on how fast the player moves that might be working fine.

However, this will just render the scene as usual. I did not find an API to sample the depth buffer of the Cubemap in shader graph and even if I could do that, there is a difference between the depth in the depth buffer and the distance of the point to the camera center. In fact, it took me a while to figure that out. First, I sampled the depth of the depth buffer at the point. This however resulted in strangely curved shadows. The reason for that is quite complicated, but in the Unity forum bgolus always show this image which shows that very good and that has been very helpful for me:

You know, in our shader we already have a calculation that calculates the distance of the point on our current fragment to the center of the plane. By just feeding that value in our comparison to the depth buffer got me these strange curves that you can see above in the image. That is, because you are comparing apples with pears.

So, what we need is either complicated maths in our shader to calculate the depth buffer to the distance, or creating a customized renderer for our occlusion camera. I went for the second option, as it was easier for me and to be honest, after hours of building huge shader graphs with a lot of maths and custom functions I couldn’t figure it out!

But, I didn’t need to:

As the plane and the occlusion camera will not be rotated or scaled and also not being transformed (as only the player parent object will be translated) we can just work in “object space”, which makes things a lot easier.
So, we don’t need all those transforms and matrix stuff, both pixel spaces will be the same for the occlusion camera and the plane.

I started the project as a Universal Render Pipeline, so I can quickly create my own renderer for the occlusion camera even without writing much code.

I finally came up with this solution:

Create a new Shader Graph for the occlusion camera
Create a new Render Pipeline and render the scene with that shader (I think you could do the same without URP by setting the shader for the camera in script) in the occlusion camera
The shader does not write the depth but the actual distance between the center of plane and the point on the plane, corresponding to the way we do it in the plane shader - this way we compare apple to apples!

So, I created a new renderer asset and set that as the renderer of our occlusion camera. I also created a new Layer Audio Occluder and made the camera to only render audio occluders.

Next, we have to create our “Depth Shader” in Shader Graph. It looks like this:

As you can see, it’s super simple. As in our shader before, we just calculate the distance between the center of the plane and the point on the plane. However, we need to map that value to the range of 0 to 1, so we need to divide by the radius. It’ll be 5 as we set that in our shader before. In this case, we don’t put in a shader variable but we just set the far plane of the camera to 5 and use that value in the depth shader. Setting the far value of the camera made also sense because we don’t need to render the whole scene, just what is in our radius.

Then, we feed that shader in our Render Depth pipeline like this:

So, what this does, is overriding all materials in the scene with our depth shader and rendering the audio occluders into our cubemap.

The cubemap looks like that:

The top and bottom is black, because we don’t render them. In our script we had this line:

cam.RenderToCubemap(cubemap, 51);

51 is the bitflag for front, back, left and right. The typical value you see in the Unity documentation and many examples is 63 which is the bitflag for all six sides. But we only render into a plane, so we don’t care about top and bottom.

Using the distance buffer

Now that we have our distance buffer indicating the distance of all occluders 360° around the center of the plane we need to do something with it. In fact that’s pretty easy. We just sample the point on the plane and on the cubemap and figure out if the point is occluded or not. If it is, we just set the alpha value to 0. If not, we set it to our usual 0.0 to 1.0 distance range that we use to calculate fall-off and ripple intensity. Here is the relevant part of the shader:

Pretty simple, right? We can just use the position of the fragment in object space and feed that as the view direction into our cubemap. Please note, this only works, because we never rotate or scale the plane and the camera.

This is the complete shader. I added normals based on the ripples and a few other things like a base color, highlight color for the ripples and also a base opacity if you want to show the whole radius.

If we use this shader, we get what we wanted, a nice looking circle with audio ripples falling-off to the edges of our audio falloff settings and with “audio shadows” generated by the occluders.

Conclusion

It’s been a lot of fun figuring out all of that. And I think the results are great. If you have any comments or additional info on how to improve that, please tweet me at @ursuppe.

When I created that, I thought that it’s also worth taking into consideration not only for audio occlusion system, but you can also create nice effects. Like spherical explosions that don’t run through buildings but stop behind buildings. A texture map with occlusion could also mask damages to the scene behind buildings, so you would only render the “fire” material only where the explosion could be exposed and not being blocked by buildings. This is why I wrote that blog post. Perhaps it’s inspiration for many other use cases.

Universal Rendering Pipeline in Unity is great for these kind of things. It’s easy to create your own renderers can do a lot more than in the built-in render pipeline.

Last but not least I want to link a few resources that have been very useful for me:

`}),e.add({id:3726,href:"https://www.4players.io/blog/why-in-game-communication/",title:"Creating technology based on players’ motivations: why in-game communication?",section:"4Players Blog",description:"Multiplayer gaming is popular and offers a positive gaming experience, but requires a reliable chat system to maintain smooth and enjoyable gameplay.",content:`

We all love games, no matter what shape or size they come in. ‘Playing’ is a key component of life, and helps break up mundane activities. We have discussed this aspect in our blog before, but today we will focus on multiplayer gamers - their motivations, how they communicate, and how this drives us to do what we do.

There are roughly 3.2 billion gamers across the globe. When looking at a more precise breakdown, there are around 1.47 billion gamers in Asia. This includes 419 million in Latin America, 284 million in North America and approximately 716 million across Europe.

More than half of the global population plays games (52%), and 77% of them play multiplayer.

With the increased popularity of multiplayer games, it is imperative to analyse the advantages of choosing this modality and the player behaviours they encourage. It is clear that the first and most significant motivation for multiplayer gamers is having a positive games experience together. The social aspect and interactions during multiplayer gaming, where players can help each other and interact, became clearer than ever during the pandemic. This beats the idea that games can cause alienation from society. These social connections are key to team building, boosting competition and strategic thinking, self-reliance, and working as a group.

Another critical factor is the improvement of attention skills. Players need to concentrate deeply in multiplayer gaming - not just on themselves, but on their surroundings and the positioning of their enemies. This is needed in order to always remain one step ahead and achieve success.

The importance of communication in multiplayer gaming

All these things make it clear that the ability to communicate during multiplayer games is of the utmost importance. This is not only for smooth playability but also for the full enjoyment of the player experience. Nothing is more disruptive than being unable to communicate during a multiplayer game session. In a match between two teams with equal skills and equipment, the team with better communication skills and tools will always win.

Players will constantly use in-game and external communications to discuss tactics and strategies to achieve the most optimal gameplay experience. If the in-game voice and text chat is faulty, disruptive and/or inefficient, players will immediately turn to external tools to solve these issues. In some extreme cases, they might even leave the game altogether if the frustration level becomes too high. Therefore, it is critical to choose the right chat tool when developing your multiplayer game.

What part have we played?

When developing ODIN, some of the key focal points we had in mind were:

We wanted to create game communication that was the closest to life-like as possible. As players ourselves, we were fully aware of the importance of a fully immersive experience. This is because we wanted players to feel like they were part of the game. It always disturbed us that we weren’t able to quickly direct our teammates when they were communicating with us in the game. So we created ODIN as a solution to this.

We wanted to make it as fast and simple as possible for developers to offer the most effective in-game communication in their multiplayer games. There are many enjoyable games out there that would be even better if they could take full advantage of in-game chat. Sometimes, especially when dealing with a lack of resources, the cost of implementing this feature and maintaining it becomes too much for the developer. As a result of this, their players suffer, as they can’t fully enjoy the experience. With advances in technology, that should not be an issue.

We also made sure that everything was cross-platform, using the same code and with high performance. This is so the developers can work in peace and the players can enjoy it everywhere.

At 4Players we always keep players’ safety and data protection in mind. Players care about this and so do we - so we make sure our tool doesn’t require any personal data to work properly, making it safe for both developers and the community.

As game developers must have heard a million times, it’s all about the players - the audience. For us, the motivation is the same. It’s all about the players, allowing them to fully connect and immerse themselves, without disruptions. In 2023, we aim to take it even further.

`}),e.add({id:3727,href:"https://www.4players.io/blog/4players-releases-odin-server-for-on-premise-hosting/",title:"Introducing ODIN Server for On-Premise Hosting",section:"4Players Blog",description:"Run our server software on your own infrastructure for complete control and customization of your deployment environment.",content:`

At 4Players, we understand that different businesses have different hosting needs. That’s why we are excited to announce that we now offer on-premise hosting packages for ODIN customers.

Traditionally, the ODIN server software has been available as a cloud-based solution, allowing users to access it from anywhere with an Internet connection. While this has worked well for many of our customers, we understand that there are certain situations where an on-premise solution might be preferred.

That’s why we have developed on-premise hosting packages for our server software, which allows you to have both the ODIN server and gateway installed and run directly on your own hardware, with the added support and expertise of our team. All ODIN on-premise hosting packages offer the same features and functionality as our cloud-based solution, but with the added benefits of increased control and security. You can have complete control over your server infrastructure, and can ensure that your data is kept secure within your own network.

On-Premise Hosting Documentation

Downloads for the on-premise version of the ODIN server software are now available right within our customer control panel. This makes it easy to access the software and get it up and running within your own infrastructure. You can also generate configuration snippets for both the ODIN server and gateway based on your individual access key.

Generate Configuration for On-Premise Servers

We believe that these on-premise hosting packages will be particularly useful for developers who have strict compliance requirements, or who simply prefer to have their data stored on-site. It is also a great option for customers who want to be able to customize their server setup to meet their specific needs, but don’t have the in-house expertise to do so.

We are confident that these on-premise hosting packages will be a valuable addition to our server software offerings, and we hope that they will be a useful tool for our customers. If you have any questions about this new release and specifically our new pricing model, don’t hesitate to reach out to our sales team.

We are always happy to help!

`}),e.add({id:3728,href:"https://www.4players.io/blog/the-challenges-of-starting-a-career-in-gaming/",title:"The challenges of starting a career in games",section:"4Players Blog",description:"The gaming industry can be a profitable and viable career choice, and it is currently growing and surpassing other creative industries.",content:`

Following the 4Players Talks we conducted, discussing how experts started their careers in games, we thought it would make sense to address some of the biggest challenges newcomers can face. Each individual is unique and not all challenges may be covered here, but these are some of the most common ones we see students and job seekers facing as they enter this industry.

Is it a real job?

It might be surprising for some, but for a lot of people not familiar with the gaming industry and games is not always seen as a feasible or profitable career. More than once, when stating we worked with games, we have faced the statement ‘But games make no money’ - which is alarming. A lot of parents are still sceptical that a career in game development can provide a good living, but it certainly can. That’s without considerable a career as a professional player, esports is a world of its own (and deserves its own article).

For the professionals in this industry, there is no doubt: the games industry is extremely profitable and it is overtaking other creative industries. So it is a great time to start a career in this space.

What role should I choose?

There are a wide variety of roles available in this industry. To be honest, there is space for almost all knowledge pools and expertise, as long as you are smart in applying it to game development and business. So whether you are a programmer, designer, artist, business, marketing, customer service, or data expert, there is certainly space for you in the games industry. We highly advise anyone interested in a career in games to research the jobs available and also talk to professionals in the fields of your interest in order to decide the path that best suits you.

Being an expert vs. being a generalist

Our parents came from a culture where people tended to specialise in one role and stay in this role for their entire careers. Times have changed, and nowadays it is not only common but celebrated when people tackle challenges in different positions and learn extra skills from these experiences.

In larger companies, it is more common for individuals to focus more on specific tasks, with less differentiation. Smaller companies tend to be more flexible, although this is not a universal truth and it all depends on the company culture.

“I advise smaller teams to hire people with multiple skills who are proactive”, says Alexei “Lex” Ryan, from Wildlife Studios. “Set up a culture where it’s encouraged for people to dip into other crafts and support across teams. This helps them acquire more career options later on and helps the team to get the most out of people. I think it’s a mistake to view humans as a narrow skillset only.”

Entrepreneur or employee

This is a question most of us have to answer at some point in our lives. Being an entrepreneur in the games industry requires certain skills and risk-taking that not all of us can tackle. Of course, being your own boss and creating the games of your dreams can be a very enticing idea for most, but researching the market, producing the required plans, securing funds, and building a team are essential tasks that not everyone wants to take on.

Entry level jobs

One of the most discussed issues when it comes to securing a job is the lack of zero-experience roles available in the industry. Most ‘entry-level jobs’ still require some previous experience. But all is not lost: working on game-related projects while studying or doing internships can give you enough experience to land a good entry-level job in the games industry. Additionally, indie game companies tend to be more flexible, as long as you can demonstrate your skills.

Additionally, companies are constantly being pushed to offer more zero-experience opportunities to the industry.

“The games industry is perhaps the most creative and international industry, and I think that makes it attractive”, adds Oleg Paliy, from Game Factory Talents. “But breaking into the industry is not that easy. Juniors cannot find entry-level roles, and when they do the skills required are way more advanced than their studies or solo beginnings have provided for them. They also often lack the network and opportunities that more seasoned industry professionals have. For those making a jump from another industry, they often have difficulty identifying the skills they need for that jump, and which ones that they already have are transferable.”

“The biggest challenge is to show that you have the experience that they want for the job. You can’t stop. You just have to keep getting experience”, adds Cami Smith, from ggLocators.

Further advice

Throughout our long careers in games, we have learnt a few extra things we would like to share:

Networking is key

It doesn’t matter what stage you are at in your career and what you are trying to pursue, networking is a must. Connect with as many people as you can, share experiences, and make friends. There is no easy way of saying this: networking can help you advance in your career. It is the cold truth. Knowing a large number of interesting people will help you to land jobs that you wouldn’t even get to know were available otherwise.

Be open and helpful

Be ready to help others and share your knowledge. The gaming industry is a great place to work because most professionals tend to be very open to mentorship and happy to share their experiences to help others. It is not only good karma, it has a good for your reputation. And don’t do it expecting anything in return - do it for the pure fact that you wished others would do that for you when you started. Hopefully, you got the help and are spreading it further.

It is not always about money

We all want to make a living and need good salaries and work conditions. That is a must and it is not what we are addressing in this advice. But sometimes it is OK to do things because we believe in the cause, to change the world for the better. It is part of giving back. The gaming industry has the power to influence the world positively. We should all be ready to do our part, in any small way we can.

And that is not all, Smith expands:

1. Build games – “Studios big and small want to see your work. Participate in events like Global Game Jam or go to Itch.io The more games you make the more skilled you will be working through a pipeline. That shows that you can work with other team members too.”

2. Keep learning – “ArtStation.com has an excellent learning platform. Some of their classes are free. Or check out schools like Gnomon.edu or CGMastersacademy.com – Just keep perfecting your skills.”

3. Volunteer at the big gaming events - “You must apply early but getting an opportunity to volunteer at GDC or PAX,and PocketGamer events are all excellent ways to meet people in the industry. Or get involved with your local IGDA. Also apply for their scholarships. There are active IGDA chapters all over the world. If one isn’t active in your area, start one.”

4. Apply for internships – “You need to apply early. Keep track of when studios are going to open their internship applications. Reach out to the indie studios in your area and see if they are looking for any interns.”

Paliy agrees and adds “Network whenever you can and join industry events locally and online e.g. Games Job Fair , ensure you have a great and up-to-date Portfolio, CV, and cover letter template you can modify depending on the role you are applying for, keep your LinkedIn page updated, and use its services for professional networking as well. Also, seek mentors. This industry has many people ready and able to help you bridge the gaps. It’s important to remember this as well: The bigger the studios the more specialised the talents they seek, the smaller the studios the more generalised. I’d say aim for a start with a smaller studio to get the understanding of the process and the skills required and later, when you figure out your key specialisations, you can move to bigger studios and more ambitious projects.”

Do it because you love it

If you want to be in the games business because you want to be rich, you might be disappointed. There are other innovative careers that would give you those results a lot faster and easier.

You should start a career because you love it. The average person will spend 90,000 hours at work over a lifetime. This is one-third of your life. So make the most of it.

“Don’t give up. Just keep trying to add skills, make friends, and build games.

It is worth all the effort!”, Smith says.

We hope this advice will give you a good kickstart for a long and happy career in our community. Most of this advice can also be applied to other areas, so use them at will. We, at 4Players, deeply love what we do and love games and the games industry. Taking on new challenges and moving forward is made possible by our deep appreciation for games. Seeing our developer and player communities truly enjoy their experiences with our support is the fuel for a lifelong passion for game development. We wish you all the same happiness we have.

`}),e.add({id:3729,href:"https://www.4players.io/blog/stepping-into-the-holodeck/",title:"Stepping into the holodeck",section:"4Players Blog",description:"Patty describes how close we are already on our way to bring the holodeck.",content:`

All of us Star Trek fans dream of stepping into the Holodeck and experiencing a different reality. The idea of fabricating any environment and situation our minds can dream of and be able to interact with it is fascinating to us. It is not necessarily an escape from reality; it can be the chance to re-live our happiest moments and create new ones that wouldn’t be possible in the real world.

“I would like to see technology move into Holograms in a way that every living room could create an environment that is surrounding us. Gaming is a way of life and it’s becoming like that”, says Tsahi Liberman, from Styrax Studios Inc. Studios, during his 4Players Talks about immersion.

We have talked about immersion in this blog before, but today we would like to focus on immersion as a creative tool to improve mental health and quality of life.

Everyone has been using their imagination since they were born. Observing children, we can see how easy it is for them to step into other worlds, even before they consciously know anything about Live Action Role Play or LARP. Children role play their favourite fantasies in such a natural way, it is almost like their reality is fluid.

In Reality is Broken, Jane McGonigal explores how game design and immersion can improve quality of life and help us deal with issues that would be soul-crushing otherwise. As reality is not designed to motivate us or even to maximize our potential and skills, structuring once boring and mundane activities as simple games can be the solution, allowing us to explore the world in a ludic way.

“A game is an opportunity to focus our energy, with relentless optimism, on something we’re good at (or getting better at) and enjoy. In other words, the gameplay is the direct emotional opposite of depression”, declares McGonigal.

The way we see it, using game design to deal with everyday activities is the perfect way to create immersion, even in situations where concentrating can be hard. We enjoy the activities where we can truly immerse ourselves, even if we are role-playing our own real-world character.

Additionally, using the game design concept of Fiero can improve our way of dealing with complex and frustrating situations. Fiero is the feeling of emotional elation after a discovery or victory (usually seen in gamers when they throw their arms in the air and yell). It is the most powerful neurochemical high one can experience. The chase for the feeling of Fiero can be a great motivator for fighting difficult situations and avoiding giving up on them and yourself. Using game design, we can truly explore frustrations and not allow them to lead us into depression. It’s all about play.

A good example, outside games, of the power of immersion is the Oscar-winning film ‘Life is Beautiful’. While prisoners, the main character tells his son that the concentration camp is a complicated game, in which he needs to fulfil quests, earn points and secure a well-defined prize. In this game, any complaint or sign of sadness strips the player of points. Although this is a very sad story, it is interesting to see how immersion in creativity and imagination can help us deal with unforeseeable situations.

Another great example of game design and immersion changing lives is the Quest 2 Learn school in New York. It has designed its whole educational system based on games, focusing on teaching critical thinking, and strategy-building skills, allowing the students to fully explore their creativity.

But what is the role of technology in all that? It is a very important role. As technology is helping us create more comfortable living conditions and more productive working environments, it is important to use it to also improve quality of life and mental health.

With the advance of VR and AR, we will be able to shape our reality to support our constant growth and help us connect with others. Simulations already allow us to become proficient in dangerous activities without risking our lives. Adding gameplay experiences also helps us to enjoy and feel motivated by these activities, increasing productivity.

“A deep immersion into a possible future creates lasting mental habits, especially when it comes to watching the real world for evidence that the simulated possibility is becoming more likely”, says McGonigal.

In the future, we hope companies will talk about quests and achievements rather than KPIs. We hope schools won’t use homework as punishment, but as tasks for a higher goal. And we truly hope our spatial sound and network solutions can help technology achieve the true immersion the community deserves.

`}),e.add({id:3731,href:"https://www.4players.io/blog/4players-releases-odin-core-sdk-v1.3.0/",title:"ODIN Version 1.3.0 is Available",section:"4Players Blog",description:"4Players is pleased to announce the immediate availability of the latest ODIN SDK - adding support for Windows on ARM.",content:`

We’ve just published version 1.3.0 of the ODIN SDK. We have some exciting updates to share with you.

First and foremost, we have added support for Windows on ARM. This means that users of these devices can now take advantage of all the features and functionality ODIN has to offer. We have also refactored our internal jitter buffer for improved reliability. This helps to smooth out any variations in the arrival time of audio packets, ensuring that audio playback is as smooth as possible. This update should result in even more reliable audio processing for all users.

The new builds are available on GitHub.

Download Version 1.3.0

In terms of API changes, we have updated the OdinAudioStreamStats struct to better reflect the data it contains. We have renamed several fields and added several new ones, so be sure to check out the changelog for all the details. We have also removed the odin_audio_data_len function. In addition to these updates, we have made a number of bugfixes and improvements, which should result in a more reliable high-quality audio processing experience for all our users. We hope you enjoy these updates and as always, don’t hesitate to reach out if you have any questions or feedback.

Updates to both our Unity and Unreal Engine plugins will be available within a few days.

4Players ODIN

Here’s the full changelog for this update:

New Features

Added support for Windows on ARM
Refactored internal jitter buffer for improved overall reliability

API Changes

Updated OdinAudioStreamStats struct
- Renamed jitter_packets_processed to packets_processed
- Renamed jitter_packets_dropped_too_early to packets_arrived_too_early
- Renamed jitter_packets_dropped_too_late to packets_arrived_too_late
- Renamed jitter_packets_lost to packets_lost
- Added packets_total
- Added packets_invalid
- Added packets_repeated
Removed odin_audio_data_len

Bugfixes / Improvements

Enabled FEC feature for Opus encoder/decoder
Switched Opus encoder application mode from Audio to VoIP when working with single channel streams
Fixed initial values for time and sequence number in audio datagrams
Fixed a bug where malformed audio datagrams could lead to delayed audio playbck

`}),e.add({id:3735,href:"https://www.4players.io/blog/4players-releases-odin-core-sdk-v1.2.0/",title:"ODIN Version 1.2.0 is Available",section:"4Players Blog",description:"4Players is pleased to announce the immediate availability of the latest ODIN SDK - focussing on stability and performance improvements.",content:`

We’ve just published version 1.2.0 of the ODIN SDK. With this release, we’re focussing on stability and performance improvements. Once again, thank you for all of the amazing feedback! Due to the close collaboration with you - the developers - we’re able to constantly improve our services and make ODIN even better.

The new builds are available on GitHub.

Download Version 1.2.0

In terms of stability, we’ve refactored our internal reconnect mechanism, which will now re-establish connections in a faster, more effective way. In addition, we’ve fixed a rare but nasty bug where an ODIN room handle could become unresponsive in case of a connection timeout.

Also, we’ve added the user identifier of the local peer to the Joined event. Since tokens should be generated on a server, previous releases forced you to look in the JWT claims to get that information, so this change should make the whole authentication process more convenient and straight forward.

Updates to both our Unity and Unreal Engine plugins will be released later this week.

4Players ODIN

Here’s the full changelog for this update:

General

Updated test console client

API Changes

Added OdinRoomConnectionState_Disconnecting
Added own_user_id and own_user_id_len to OdinEvent_JoinedData

Bugfixes / Improvements

Improved internal shutdown process to prevent media handles from being removed too soon
Fixed an issue where a room handle could become unresponsive after a timeout

`}),e.add({id:3737,href:"https://www.4players.io/blog/why-building-an-international-community-can-make-a-difference/",title:"The world is our oyster: why building an international community can make a difference",section:"4Players Blog",description:"Internationalization and going global is a challenge for many companies. We share our experience and how we are building a community around the world.",content:`

There was a time when it was enough to stay local - exporting was a choice and working exclusively in your own region was a suitable option. With the introduction of the internet, everything changed. Local businesses began to get a taste of the global life - for technology companies, going international became a must. The idea of building a global community is very appealing, but it is not easy. Several things must be considered for it to work.

To build a global reach, it is crucial to understand the importance of cultural diversity and creating rapport through social engagement. People are keen to connect, so give your community good reasons to want to connect with you. Every new area you move into is different, but there will always be common features that connect them. These cultures are a melting pot of uniqueness, linked by feelings, needs and thoughts - connect these and you will paint a picture that only your global community can colour.

It’s vital to have clear goals when it comes to your community. Create a visual statement so your members know why and what they are joining. This way, you can guarantee you are attracting and retaining the right people. Create a friendly online space where your members can communicate and connect, people want to engage in discussions, and have an open platform to ask questions and be heard. Make sure their experience is pleasant and that accessibility and transparency are words you’ve always got in your mind.

Talking about transparency, remember you are connecting with people from all over the world. They all have different views and experiences, but they all understand and recognize honesty. Being clear and careful about cultural and geographical nuances will help you build a true relationship with the members. Don’t think one size fits all – embrace the differences and be flexible, all while being yourself. You won’t attract everybody, but the members who join you will appreciate what you are trying to do and remain with you.

Working with people worldwide may seem like a herculean task, but breaking it into sub-communities and covering several sub-topics allows you to diversify the global community, making it easier to share and find information. Remember, this is not about you: this is about adding value and creating connections, fulfilling your community’s needs and wants, and building loyalty. Understand your audience,support them, and you will go a long way.

For us at 4Players, it is all about our global community – building it and growing it. That is why we are so keen to attend events all over the world and to listen to what developers and players need. Meet us at W <3 Games in Helsinki, MEGAMIGS Festival in Montreal, Scottish Games Week in Dundee, and G-Star in Busan. This is only the beginning. We want to support developers and players from all over the world, so there is much more to come in the future, and it’s looking bright!

`}),e.add({id:3738,href:"https://www.4players.io/blog/why-connection-is-more-important-than-business/",title:"Why connection is important for more than business.",section:"4Players Blog",description:"Networking is an important aspect of business and personal growth. Here is why!",content:`

This week, we were lucky enough to attend and present at PGConnects Helsinki, event organised by Steel Media Ltd. Seeing our friends and colleagues in the industry in person again after a long period of isolation, made us reflect on the importance of connections.

We have previously discussed the effects of isolation on mental health. Now, we would like to discuss the importance of networking for business and personal growth.

As developers, it’s common to think that all we need is our team, our creativity and our skills. This may be true when it comes to the production phases, but without the feedback and support of business peers, success can wander out of reach.

Networking is one of the most challenging yet beneficial tasks for companies. It requires skills that are not as tangible and simple to explain as programming or artistic talents, and it takes time and dedication to bring in results.

Networking is the art of building trust and a rapport with your peers. It implies a connection different from friendship, but no less complex. Knowing people is not enough. It is necessary to understand and show true interest in others, be open to sharing thoughts and ideas, and be at the ready to start meaningful discussions that could lead to exciting new prospects and opportunities.

If you see events as a way to get clients, have quick business meetings or achieve sales targets, you are in danger of being inefficient and potentially viewed as obnoxious. Some developers will avoid you, others will meet you out of their business needs - but they won’t enjoy the encounter.

If you see events as true opportunities to connect with people and learn interesting things, you will always be satisfied with the results. In order to do that, you need to have a sincere interest in others and have an open mind about how your product or project can support them. It’s not about you. It’s about them.

These are the core values we at 4Players live by: with curious minds and a deep desire to be helpful. Our partners, our community, our players and our developers are the king. These people are the stars that motivate us to keep creating great tools for them to produce their magic.

So we are very thankful for the opportunity to attend and present at events like PGConnects Helsinki, to share our insights and meet amazing developers and partners.

Deep connections are key for us at 4Players, and we hope that with ODIN and 4NetPlayers, we can continue to support players and developers to forge deep relationships.

`}),e.add({id:3739,href:"https://www.4players.io/blog/4players-releases-odin-core-sdk-to-v1.1.1/",title:"ODIN Version 1.1.1 is Available",section:"4Players Blog",description:"4Players is shipping a new release of the ODIN core SDK, addressing feedback, bugs and improvements.",content:`

Happy release Tuesday! 🎉

The 4Players ODIN development team is please to announce the immediate availability of ODIN version 1.1.1. This release focuses on addressing your feedback as well as bug reports and feature requests.

You can see the full changelog for more details:

General

Updated test console client

New Features

Added gain controller to bring the input audio signal to an appropriate range when it’s either too loud or too quiet

API Changes

Added gain_controller boolean to OdinApmConfig struct
Updated odin_error_format to make error messages more specific
Updated odin_room_update_user_data to return an error when trying to set user data of the room while not being connected

Bugfixes / Improvements

Fixed a bug where peer user data was not set after re-connecting to a room
Fixed a bug where peer position was not set correctly before joining a room
Fixed an issue where iOS clients were unable to access local root certificates

`}),e.add({id:3741,href:"https://www.4players.io/blog/knowing-your-audience-players-profiles/",title:"Knowing your Audience: Players Profiles",section:"4Players Blog",description:"Patty describes why knowing your players is key to success.",content:`

As game developers, there is one ingredient to the success of a game that we should never forget: the players. Without players - without an audience - having the best game ever means absolutely nothing. They are the movers and shakers, and at the heart of why games are made. Understanding the audience, their motivations and standards, can be a game changer ( pun intended) in creating a successful and long-lasting product.

Richard Bartle, researcher who created the Bartle Test of Psychology, dissected the taxonomy of player types. Through his tests, he identified four key classifications of players. It’s important to note that these categories aren’t rigid, and most people display traits in more than one category. Knowing their dominant trait allows developers to foresee the majority of features that should be used and which other features can be added in smaller amounts, to appeal to the other categories. Plus, it is always more interesting to make informed decisions rather than just half-educated guesses.

The Achiever

An explicit planner and implicit opportunist are characteristics of this profile at heart. They are all about points and status, being able to check and showcase their progress at all times. They not only want to collect all achievements and badges, they will proudly display them. This kind of player will respond well to incentive schemes and faster routes to success. Bartle estimates that roughly 10% of players are Achievers. They are very conscientious, ambitious go-getters, who often rush to finish daily tasks and challenges. They will seek praise from Socializers, even if not explicitly or directly.

The Socializer

The largest profile group, Socializers account for approximately eighty percent of people who play games. For Socializers, the fun part of playing games is the interaction and connection to friends and peers. They enjoy collaborating for bigger rewards, using games as a healthy path for richer social environments.

Social games and platforms, as well as metaverses, appeal to Socializers, as they are not seeking out fierce competition, but support. This doesn’t mean they aren’t ambitious. They are networkers, love large audiences, and are agreeable and friendly. They start and hold conversations in voice chats, join guilds, and are a frequent voice in chat rooms and discussion forums - you got the idea. We have all encountered a Socializer at one point in our gaming journey, whether this be in a game or hanging out in a forum.

The Explorer

An inquisitive bunch, the Explorer wants to experience new adventures and discover new secrets. They are happy to pursue repetitive tasks and explorations, as long as it unlocks rewards such as easter eggs or a new secret level. They are not impressed by badges or interested in gloating about their achievements. The Explorer gains inspiration from experimenting, finding new ways to exploit the game to reach new, unseen areas. Open-worlds and sandbox games are their playground, and they’re not in a rush either, exploring everything at their own pace – and enjoying every minute of it. Around 10% of players fit this profile.

The Killer

Although the name is a bit scary, the definition isn’t. Killers are similar to Achievers, but with a twist; they want to see other people lose. As you could guess, they are highly competitive, and motivated by being the winners - and to be true winners, everybody else needs to fail. They are politicians, out for blood and chaos, but very conscious of their status and reputation. They prefer live PvP and are prone to use scripted cheats whenever possible. This category is very rare: less than one percent of players.

So, what did we learn? When keeping these profiles in mind, it makes it easier to understand why games like Farmville and platforms like Roblox are so successful, but this just scratches the surface. In order to make the right decisions for your game design, proper player research and analysis is essential, and can take you a long way.

We would love to know which kind of player you are. We would say broadly that we are Socializers and Achievers, ready to use ODIN and 4NetPlayers to interact with our peers, while keen to better ourselves every step of the way.

For us at 4Players, it doesn’t matter if you want to appeal to the Socializers, Achievers, Explorers or Killers, if they are there to chat, join adventures or boast: we want to provide developers the tools to make the player’s experience top level and unique. We are here for all of you!

`}),e.add({id:3742,href:"https://www.4players.io/blog/4players-releases-swiftui-sample/",title:"4Players Releases SwiftUI Sample App",section:"4Players Blog",description:"Learn more about OdinKit and how to use it in your iOS and macOS applications by studying our SwiftUI sample.",content:`

After releasing our OdinKit Swift package for iOS and macOS, we now pushed the code for a very basic SwiftUI sample application to GitHub.

Xcode Screenshot

The app is built around OdinKit and implements all APIs required to provide real-time voice communication for your users. It also shows how to use an OdinRoom instance to synchronize data between all users in the room.

Learn more about the sample and how to get started in our example description:

Get Started with Swift

`}),e.add({id:3744,href:"https://www.4players.io/blog/4players-releases-odin-swift-sdk-v1.0.0/",title:"4Players Releases ODIN Swift Package",section:"4Players Blog",description:"We now empower iOS and macOS developers to add real-time voice communication to their games and apps with OdinKit.",content:`

Now that our team is on a release spree, here you have OdinKit - a Swift package providing an object-oriented wrapper for the ODIN native client library, which enables developers to integrate real-time VoIP chat technology and real-time data synchronization into multiplayer games and apps on macOS and iOS.

With OdinKit, we’re not only following Apples naming convention for APIs. We’re also shipping an XCFramework, which is a distributable binary package created by Xcode that contains variants of the ODIN client library so that it can be used on multiple platforms. Currently, we provide support for both Intel and Apple Silicon based Macs as well as iOS devices.

The package is open-source and available on GitHub.

Swift Playground

The project contains a macOS playground to demonstrate how to use OdinKit in your your apps, but the same code will also work on iOS and iPadOS.

Getting Started

After adding the package to your project, import OdinKit into your application:

import OdinKit

In ODIN, every user connected to the same room can exchange voice and data. You can also join multiple rooms at once, for example one lobby but additional private chats or another room only used for text messaging. So, we create a room instance like this:

let room = OdinRoom()

Handling events

ODIN will notify you of important events like a new user joining the room or a user leaving the room. You can handle these events to build your business logic on top of it. In Swift, we use the delegation pattern to handle these events.

So, we create a class implementing the OdinRoomDelegate protocol:

// Define a class handing events
class YourCustomDelegate: OdinRoomDelegate {
    // Callback for internal room connectivity state changes
    func onRoomConnectionStateChanged(room: OdinRoom, oldState: OdinRoomConnectionState, newState: OdinRoomConnectionState, reason: OdinRoomConnectionStateChangeReason) {
        print("Connection status changed from \\(oldState.rawValue) to \\(newState.rawValue)")
    }

    // Callback for when a room was joined and the initial state is fully available
    func onRoomJoined(room: OdinRoom) {
        print("Room joined successfully as peer \\(room.ownPeer.id)")
    }

    // Callback for room user data changes
    func onRoomUserDataChanged(room: OdinRoom) {
        print("Global room user data changed to: \\(room.userData)")
    }

    // Callback for peers joining the room
    func onPeerJoined(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) joined the room with ID '\\(peer.userId)'")
    }

    // Callback for peer user data changes
    func onPeerUserDataChanged(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) updated its user data to: \\(peer.userData)")
    }

    // Callback for peers leaving the room
    func onPeerLeft(room: OdinRoom, peer: OdinPeer) {
        print("Peer \\(peer.id) left the room")
    }

    // Callback for medias being added to the room
    func onMediaAdded(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) added media \\(media.id) to the room")
    }

    // Callback for media activity state changes
    func onMediaActiveStateChanged(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) \\(media.activityStatus ? "started" : "stopped") talking on media \\(media.id)")
    }

    // Callback for medias being removed from the room
    func onMediaRemoved(room: OdinRoom, peer: OdinPeer, media: OdinMedia) {
        print("Peer \\(peer.id) removed media \\(media.id) from the room")
    }

    // Callback for incoming arbitrary data messages
    func onMessageReceived(room: OdinRoom, senderId: UInt64, data: [UInt8]) {
        print("Peer \\(senderId) sent a message with arbitrary data: \\(data)")
    }
}

Next, we assign that delegate to our room instance:

// Create an instance of your delegate
let delegate = YourCustomDelegate()

// Add the delegate to the room
room.delegate = delegate

We also provide a set of published properties for typical use cases so you don’t have to handle these events yourself. This is ideal if you’re using SwiftUI, as your views will notice any changes automatically.

struct RootView: View {
    @EnvironmentObject var room: OdinRoom

    var body: some View {
        switch room.connectionStatus.state {
            case OdinRoomConnectionState_Connected:
                RoomView()
            default:
                LoginView()
        }
    }
}

Joining a Room

That’s it for event handling. We are now ready to join a room. For this, we need to an authentication token. ODIN generates signed JSON Web Tokens (JWT) for secure authentication, which contain the room you want to join as well as a freely definable identifier for the user (e.g. a player ID or a user ID from your database).

// Create a new local access key
let accessKey = try OdinAccessKey("__YOUR_ACCESS_KEY__")

// Generate a token to authenticate with
let authToken = try accessKey.generateToken(roomId: "Meeting Room", userId: "Swift is great!")

The roomId is just a string and uniquely identifies the room within your access key domain. Every user connected to the same room will be able to communicate with each other. The userId is a string that can be used to refer to an existing record in your particular service.

Info

Privacy and security is very important to us. All the data transferred over our servers is fully encrypted. Also, ODIN is completely user agnostic and we don’t harvest any data or tell our customers how things should work or look.

For your own security, we strongly recommend that you NEVER put an access key in your client-side code. We’ve created a very basic Node.js server, to showcase how to issue ODIN tokens to your client apps without exposing your access key.

We provide both PHP and NPM packages to make the process of generating tokens as easy as possible for you.

Generate an Access Key for FREE

Now that we have created our access token (which you should do on server side if possible) we can join the room and add a media stream using your default audio input device:

// Now that we have a token, join the room
try room.join(token: authToken)

// Append a local audio stream to capture our microphone
let newMediaId = try room.addMedia(audioConfig: OdinAudioStreamConfig(
    sample_rate: 48000,
    channel_count: 1
))

Warning

As OdinKit will request access to your microphone you need to set a special key in your Info.plist file. Add a key called NSMicrophoneUsageDescription (Privacy - Microphone usage description) and set a text that describes why your app wants to have microphone access. Otherwise your app won’t be able to capture audio samples from your input device.

That’s it! Congratulations! You have added real-time voice communication to your app!

What’s Next

There are many things you can do with ODIN. You could add sending text chat so that users can share links and additional data:

// Encode a string so we can send it as a message
let yourMessage = OdinCustomData.encode("So Long, and Thanks for All the Fish")

// Send the message everyone else in the room
try room.sendMessage(data: yourMessage)

Sample App

Download our sample to get started quickly and learn how to use the APIs:

Show SwiftUI Sample

Documentation

We have extensive documentation and a reference of all available classes and APIs provided by OdinKit.

Open OdinKit Documentation

`}),e.add({id:3745,href:"https://www.4players.io/blog/4players-releases-odin-networking/",title:"Announcing ODIN Networking",section:"4Players Blog",description:"4Players announces ODIN Networking - a decentralized, client-server networking solution for games and the metaverse",content:`

Today we are releasing what we have been working on for a couple of months now: ODIN Networking. Unity until today lacks a good and easy stack to build multiplayer games and applications. The old Unity Networking has been deprecated years ago and the follow-up solution is still not ready and seems to be quite complicated. So we used Photon or Mirror Networking to build multiplayer examples.

So, we went out to solve that, and we came up with ODIN Networking. This is our first public iteration, and although there is a lot of work to be done, we are quite confident that we can contribute and help developers to more easily build multiplayer applications of any scale.

What is ODIN Networking?

ODIN Networking is built on top of the ODIN Unity SDK and provides easy to use methods to built virtual experiences with ease that allow you to connect users with virtual characters and real-time 3D voice. A 3D virtual conferencing application can be built in no time, as ODIN Networking provides components that automatically synchronize position, animation of all characters over the ODIN servers.

Users can spawn objects in the world and can interact with the provided world in real-time. ODIN Networking also integrates ODIN Audio so your virtual world will automatically integrate audio occlusion (users cannot hear each other if walls are in between) and even direction.

One important aspect: While ODIN Networking is a powerful and easy to use system, it’s mainly targeted for real-world like applications for the metaverse, board games, virtual conferences and conventions. If you want to build a fast competitive first person shooter or real-time physics racing game ODIN Network might not be the best solution. Choose other solutions like Mirror Networking or Photon for that use case. You should still use ODIN for voice support, and we have many guides on how to integrate ODIN into Mirror or Photon.

How does it work?

The ODIN SDK supports sending arbitrary data over the network and this data is automatically synced with all peers connected to the same room. Each user can have its own data (PeerUserData), each room can have its own data (RoomUserData) and each peer can send messages with arbitrary data to all or selected peers.

ODIN Networking packages the current state of a player into the players PeerUserData. It includes the transform (position, location and scale), the animation state and sync vars that allow you to easily mark local variables to be packaged into the state. This updated state is sent multiple times per second (right now every 10th of a second) to other peers that recreate that state in their own world. If a peer is moving, every peer in the network gets an update 10 times a second and updates (tweens) the position locally for that peer.

Every player can also spawn objects into the world. The state of these objects are added to the PeerUserData and are thus updated as well. If a peer spawns an object, all other peers will get an update and spawn the object locally and subsequently update its position as part of the network update cycle.

Of course, players should be part of a living world, so how do you handle objects that are “owned” by the world you might ask? It’s easy. With a deterministic algorithm, all peers in the same room select the same peer to be the host. This is done dynamically, so if the host disconnects a new peer might become host. The host owns the worlds objects and updates the worls state as well as its own state in the RoomUserData. This way, peers entering later will become the same state of the world as every one else, and it’s kept persisted even if the current host disconnects, as every peer in the network has a copy of that world. This way, every peer can instantly become the host.

As it’s decentralized you don’t need to worry about a central server that might go down, and you also don’t need to have all that typical development cycle of sending messages to a server that updates the world and sends the results back as remote procedure calls, which make the whole development process extremely complicated. Now you might understand, why we don’t think ODIN Networking is good for competitive games, as its not easy to build a reliable anti-cheat system into this kind of architecture. We might explore that later, but right now we concentrate on building metaverse applications and all those games that don’t want to be the next eSports hit.

But, ODIN Networking, and the ODIN Unity SDK are open-source. We are happy to merge your contributions!

How do I get started?

All you have to do is to derive your “Player” script (i.e. that script that controls your local player object) from OdinPlayer instead of MonoBehaviour. Distribute at least one OdinNetworkSpawnPosition game object in the scene. Next, join a room, and you are ready to go! Build your application and send it a friend. Once you guys start the application, each user will spawn its own player at one of the spawn positions, and you can see the other players running around, seeing the characters animation, and you can talk to each other in 3D audio - i.e. the voice will come from the direction you see the other player and volume will be adjusted depending on the distance and direction.

How much does it cost?

As ODIN Networking uses the ODIN stack under the hood, the same pricing applies. So no extra costs if you use ODIN Networking!.

Interested?

We released ODIN Networking as a Unity project today. You can download it, fire up Unity and click Play to see it and to examine the source code. In the next couple of weeks we’ll be doing some tests and will then integrate the project into the ODIN Unity SDK.

Download ODIN Networking SDK

`}),e.add({id:3746,href:"https://www.4players.io/blog/4players-releases-odin-unity-sdk-v1.1/",title:"ODIN Unity SDK updated to v1.1",section:"4Players Blog",description:"Version 1.1 fixes bugs and improves usability.",content:`

ODIN Unity SDK 1.1.0 was released on September 1st 2022. You’ll find the latest version of the SDK in our Github repository.

General

Core SDK has been updated to version 1.0.1 (details)
Added options to adjust microphone input volume
URL to 4Players admin panel has been updated

API Changes

Added MicrophoneReader.GetVolumeScale
Added MicrophoneReader.GetAveragedVolume
Added MicrophoneReader.SetVolume
Renamed MediaStream.IsMuted to MediaStream.IsPaused

Bugfixes / Improvements

Fixed an issue where the activity state of the local media stream was not updated

Download in Unreal Engine Marketplace

`}),e.add({id:3747,href:"https://www.4players.io/blog/safety-in-technology/",title:"Safety in Technology",section:"4Players Blog",description:"Patty Toledo describes why dedicated servers might be a solution for not only technical issues but for society in general.",content:`

There is nothing more frustrating for gamers than experiencing lags and lost files. An immediate solution for those issues is dedicated servers. If we are talking about harassment and privacy issues, private dedicated servers might be the best response available at the moment.

In a time where safety and privacy in gaming are huge topics for discussion, we can’t help but think about private dedicated servers, AI moderation and voice-changing technologies, especially for online multiplayer gaming experiences. According to Forbes, over 60% of gamers, adults and minors, have suffered from some kind of harassment in online gaming. The most exposed groups are women, Black Americans and Asian Americans. Over 50% of gamers try or succeed in hiding their identities to avoid harassment.

In the US alone, 91% of the kids between two and 17 years old are playing video games. In the UK, 82% of children between 12 and 15 years old play games online, and the next generation is being brought up in full digital, online, interactive environments. This is amazingly great news, and terrifying at the same time.

Game rage is a real thing – fully documented and widely researched. From griefing, doxing, and swatting to all kinds of hate speech and aggressive behaviour, the danger is substantial and has real physical and mental consequences. Games are wonderful social tools and must be truly nurtured as such, but they can also pose grave threats to our youth. With the metaverse and full digital lives advancing, these threats need to be taken seriously and averted whenever possible.

Besides cyberbullying, privacy problems and data leaks, other dangers to be considered in online gaming are misuse of webcams, malware and online predators. It is not a surprise that many groups advocate that online gaming is harmful to their youth, but the truth is that those dangers are not only in gaming. These dangers are everywhere online and games are just the conduit for positive and negative alike.

So what can be done? Are there solutions available? We are not saying that we are 100% safe yet, but we are going in the right direction. AI moderation, both in voice, text and images, data privacy, voice changing technology, and private dedicated servers are some of these solutions. At 4Players, these issues are taken seriously and we are constantly looking for the best partners to fill all the gaps. We believe that it is possible to create safe and immersive gaming environments where our youth can learn to act in a positive way, while enjoying positive life experiences.

`}),e.add({id:3748,href:"https://www.4players.io/blog/voice-chat-sdk-odin-available-in-unreal-marketplace/",title:"Voice-Chat SDK ODIN in Unreal Marketplace",section:"4Players Blog",description:"Our large scale client server based Voice SDK is now available in the Unreal Marketplace",content:`

ODIN is now available in the Unreal Marketplace. Head over to download and install the SDK for free.

You can download, install and use the SDK for free for up to 25 concurrent users by either generating a free access key in our developer documentation or directly in the Unreal Editor using a simple blueprint.

We must thank the Unreal Marketplace team that were super fast in responding and did an amazing job of getting our SDK in record time into their Marketplace.

Using the plugin

The source-code of the plugin is freely available in our Github repository and we have created a guide to get your started quickly.

Unreal Engine Manual

We also have created an extensive Blueprint Reference Documentation that describes every node that ODIN offers in great detail and provides complete Blueprints for you to Copy & Paste into your existing project.

Unreal Engine Blueprint Reference

We can’t wait to see what you are developing with ODIN on the amazing Unreal Engine. Please contact sales if you need additional information on pricing and get in touch with our Customer Success Team if you want to be part of our “Showcase”.

`}),e.add({id:3749,href:"https://www.4players.io/blog/we-live-in-two-worlds/",title:"We live in two worlds",section:"4Players Blog",description:"Patty Toledo describes why 4Players products matter and how we attend to make the world a better place.",content:`

Our physical life is full of challenges, struggles and heartbreak. There are a lot of great things that happen, but they are mostly out of our hands. Opportunities are not dished out fairly, and most of us won’t live our “dream life” in the physical world.

Our digital life, however, can be flawless. We can be anything we want, and our fantasies can come true in the metaverse / digital world. We can have the career we always dreamed of, the respect we always craved, and the deserved recognition for our accomplishments.

As technology advances at an astonishing pace, so does our immersion into digital life. Although there are a tonne of moral and social issues in the metaverse to be considered, let’s, for now, focus on the emotional implications of immersion in the digital world.

Human beings need to be social. We need conversation, to exchange ideas and share our fears. Some individuals are more physical than others, but the concept of contact still remains. Sensory deprivation experiments have shown subjects becoming disoriented, having difficulty concentrating, being unable to solve problems, and some radical cases even experienced auditory and visual hallucinations. Our senses play a huge role in our well-being.

If the pandemic has shown us anything, it’s that being isolated can be emotionally harmful. But even though we acknowledge that, we are still focusing continuously on our digital lives. The reasons vary. Nevertheless, it’s clear that we can’t ignore the path we are walking on.

The technological tools that will allow us to truly immerse ourselves in the digital world will be crucial for our experiences and well-being. This is why what we do at 4Players is so important. Everyone online needs servers to remain connected and safe. Data protection is another important factor for us, deserving of a full blog dedicated to it. With ODIN, we offer a full 3D sound and voice experience in the easiest way possible. We apply the full capabilities that Unity and Unreal Engine already offer for best results, making life easier for developers.

As visual technology advances in strides, it is time to do the same with #audio technology. It’s one step closer to a full-on immersive experience. For many developers, sound has been put in the background, as a second-thought feature. Voice is not even considered as there are so many challenges to face in implementation and safety. But ignoring its importance to the full experience is a mistake.

As developers, we want to help the players to have varied emotional reactions to our creations, and to feel the urge to return to them, and play them over and over again. We are still not there when it comes to having all five senses engaged in the digital world, but why not assure our community gets the most of it?

To learn how we can help to integrate immersive voice chat and sound experiences into your game, visit www.4players.io or send us a message.

`}),e.add({id:3750,href:"https://www.4players.io/blog/4players-releases-odin-core-sdk-to-v1.0.1/",title:"ODIN Core SDK updated to v1.0.1",section:"4Players Blog",description:"This version fixes some issues we had with the Unreal Engine SDK",content:`

Today we released version 1.0.1 of the Core SDK.

Bugfixes / Improvements

Fixed an issue with conflicting symbols for Unreal Engine builds

`}),e.add({id:3751,href:"https://www.4players.io/blog/4players-releases-odin-unreal-sdk-to-production/",title:"ODIN Unreal Engine SDK Is Available",section:"4Players Blog",description:"4Players announces the ODIN SDK release for both Unreal Engine 4 and 5.",content:`

We are thrilled to announce that we released our ODIN Unreal Engine SDK completing support for all major public game engines used in production today.

You can download the latest release right here:

https://github.com/4Players/odin-sdk-unreal/releases

4Players ODIN

With ODIN, you can add support for real-time voice chat embedded directly into your game supporting 3D spatial audio. You can even join multiple rooms at once, combining 3D spatial voice chat with radio type voice chat.

That is all you have to do to add ODIN to your game. Hover over the image, click the Copy button and paste it into your Level Blueprint. Set your own Access Key in the Access Key variable and press Play.

Check out our Unreal Engine SDK for more details and work through our getting started guide. You can copy generate an access key for free without signing up. Copy Blueprints directly in your game and you’ll be up and running in a couple of minutes!

Get Started with Unreal today

`}),e.add({id:3752,href:"https://www.4players.io/blog/4players-releases-odin-unity-sdk-to-production/",title:"ODIN Unity SDK Is Available",section:"4Players Blog",description:"User interaction is vital to building thriving communities so start adding voice chat into your Unity game now.",content:`

A few days after launching our Core SDK to production, we also launch version 1.0 of our Unity SDK. Its battle-tested, stable and super easy to integrate into new or existing games.

We have guides for adding it to Photon based games or games built with Mirror Networking.

Download our Unity SDK today and give it a shot! You’ll not regret it.

https://github.com/4Players/odin-sdk-unity/releases

4Players ODIN

Here’s a full list of changes and improvements:

General

Core SDK has been updated to version 1.0.0 (details)
Native bindings where updated to reflect the latest SDK changes
Internal media IDs were removed from the API in favor of media stream handles
Overall audio quality and performance has been improved dramatically

API Changes

Added Room.UpdateRoomUserData
Updated functions to use IUserData interface more effectively
Renamed Room.UpdateUserData to Room.UpdatePeerUserData
Renamed ApmConfig option OdinNoiseSuppressionLevel to NoiseSuppressionLevel for sake of consistency
Replaced MediaId with MediaStreamId in OnMediaAdded, OnMediaRemoved and OnMediaActiveStateChanged event arguments
Added OnConnectionStateChanged event

https://github.com/4Players/odin-sdk/releases

`}),e.add({id:3753,href:"https://www.4players.io/blog/4players-releases-odin-to-production/",title:"ODIN Is With Us!",section:"4Players Blog",description:"After five months in open beta, 4Players is pleased to release 1.0 of the ODIN SDK to the wild.",content:`

Today is the day. After two years of development and more than five months of open beta, 4Players GmbH is pleased to announce the immediate availability of the ODIN Core SDK version 1.0. Major updates to our engine integration plugins for Unity and both Unreal Engine 4 and 5 will be released to production within the next couple of days.

The latest version can be found here:

4Players ODIN

ODIN is the result from years of expertise and experience and built from the ground up using the popular Rust programming language. 4Players combines business and industry insight with a very modern technology stack to drive growth for your businesses. We took a lot of effort to make sure developers can focus their time and resources on building the game they envisioned.

Real-time communication is essential for a fun, immersive gaming experience. This is why our dedicated development team is creating a powerful set of tools that make games more immersive, social and interactive. With ODIN, 4Players provides a complete, out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers so they don’t need to spend valuable resources designing a comms solution on their own.

Privacy and security is very important to us. ODIN is completely user agnostic and we don’t harvest any data or tell you how things should work or look.

Don’t hesitate and be among the first studios to integrate ODIN today! You can find a set of both both static and dynamic libraries as well as a single C header file in our public repository on Github.

Many thanks to all our partners, beta testers and supporters!

ODIN 1.0 comes with numerous improvements and new features such as:

General

Improved overall reliability by adding an internal mechanism to re-establish a connection to the ODIN server on timeouts
Updated test console client to properly handle reconnects
Removed the internal media ID from the API in favor of media handles (internal IDs can still be retrieved using odin_media_stream_media_id for reference while the media stream is added to a connected room)

New Features

Added a generic resampler for situations where your audio pipeline doesn’t support 48 kHz (one resampler instance should be used exclusively per audio stream)

API Changes

Added odin_resampler_create
Added odin_resampler_process
Added odin_resampler_destroy
Added odin_room_close to ensure a clean disconnect before calling odin_room_destroy
Changed type of OdinReturnCode from unsigned to signed integers
Replaced media_id and stream properties with media_handle in Media* event data
Removed unused None event tag

Bugfixes / Improvements

Fixed a bug where odin_audio_mix_streams was only outputting the last media stream
Fixed a possible deadlock when calling API functions within event handlers
Added missing null terminator to room ID and customer strings

`}),e.add({id:3755,href:"https://www.4players.io/blog/indie-campus-cologne-successful-conference-debut/",title:"Indie Campus – Cologne: Successful conference debut",section:"4Players Blog",description:"4Players and Indie Hub are very satisfied with the premiere of the indie event and are already planning the next edition",content:`

4Players and Indie Hub are very satisfied with the premiere of the indie event and are already planning the next edition.

The first Indie Campus organized by Indie Hub and 4Players in close cooperation with KölnBusiness and Atypic Labs from Québec, was a complete success. On September 14 and 15, 2021, more than 30 speakers joined the online event, making themselves available for talks and roundtable discussions to a very inquisitive audience.

The speakers, including best-selling author, Emmy® winner, and developer Don Daglow (a.o. Neverwinter Nights, Stronghold, The Lord of the Rings: The Two Towers), Dominik Lauf (CPO, Magenta Gaming), Seren Besorak (Co-Founder & CEO, TriTrie Games), Tomas Sala (The Falconeer) or Kai Schober (Community Manager, Bethesda) gave the audience not only open insights into their wealth of experience, but also many suggestions on the areas of retention and monetization in games. From blockchain usage in games to the necessity of a publisher, hints on how to go from 0 to almost 1,000,000 followers, the importance of community management as well as valuable design advice up to a wrap-up of TriTrie Games’ thematically challenging ‘Jessika’, a wide range of topics were covered and enjoyed throughout.

###Next Indie Campus in 2022 Given the positive feedback during and after the event, Indie Hub and 4Players have agreed to extend their collaboration in the future. The next Indie Campus is already being planned and is expected to take place in spring 2022. In addition, other events tailored specifically to the needs of indie developers will take place at irregular intervals, the details of which will be announced at a later date.

Marc Berekoven, Head of Business Development 4Players: “On behalf of 4Players, we would like to thank everyone who helped making the first Indie Campus a success. Together with Indie Hub, dedicated volunteers, KölnBusiness and the international support of Atypic Labs, we were able to present great speakers with interesting topics over two jam-packed days. The indie developer scene has grown a little closer through the Indie Campus, not only on a national, but also on an international level. We hope that the more than 1,000 spectators were able to take away numerous suggestions and ideas from the talks as well as roundtable discussions. We are already looking forward to the next edition.”

Stefan Schmidt, Co-Founder of Indie Hub, adds: “We couldn’t be happier that Indie Campus - Cologne was such a great success! Our special thanks go especially to my team and KölnBusiness, who have supported and encouraged us since the very first minute. And even though the theme of the next Indie Campus is yet to be announced, we can already say that we will shed light on other important topics for indie teams around the world. But until then, we will of course continue to offer a monthly roundtable and the Indie Game Fest in November.”.

`}),e.add({id:3756,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/add-media-to-room/",title:"Add Media To Room",section:"ODIN Documentation",description:"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.",content:`

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.

Important

The user must have joined the room before adding media. Use the Join Room node to join the room. Also, you cannot use the same media stream for multiple rooms at once, but you have to create a new one for each room.

Inputs

Name	Type	Description
Exec	exec
Room	Room	The room to which the media will be added.
Media	Media	The media which should be added. Construct Local Media can be used to create a media object.
On Error	delegate	Delegate to handle errors while adding a media to a room.
On Success	delegate	Called when the media has been successfully added to the room. See On Media Added Success event for details.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the gateway has returned its response. Use the `success` output to understand if anything went fine.
Success	boolean	`true` if the media has been successfully joined.

`}),e.add({id:3757,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/add-odin-synth-component/",title:"Add Odin Synth Component",section:"ODIN Documentation",description:"Adds the Odin Synth Component to the specified actor.",content:`

Adds the Odin Synth Component to the specified actor.

Inputs

Name	Type	Description
Exec	exec
Target	Actor Object Reference	The Actor to which the Odin Synth Component will be added.
Manual Attachment	boolean	When Manual Attachment is set, automatic attachment to the target actor is skipped and it is up to the user to attach the resulting component (or set it up as the root) themselves.
Relative Transform	Transform	The relative transform of the component to the target actor.

Outputs

Name	Type	Description
Exec	exec
Return Value	Odin Synth Component	Returns the `Odin Synth Component` that will output audio from the media stream assigned by the Odin Assign Synth to Media node.

`}),e.add({id:3758,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/adjust-attenuation/",title:"Adjust Attenuation",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Odin Synth Component	The Odin Synth Component to call this function on.
In Attenuation Settings	FSoundAttenuationSettings	The attenuation settings to apply to the targeted ODIN Synth instance.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3759,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/adjust-attenuation/",title:"Adjust Attenuation",section:"ODIN Documentation",description:"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.",content:`

Inputs

Name	Type	Description
Exec	exec
Target	Odin Synth Component	The Odin Synth Component to call this function on.
In Attenuation Settings	FSoundAttenuationSettings	The attenuation settings to apply to the targeted ODIN Synth instance.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3760,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/",title:"Audio Capture",section:"ODIN Documentation",description:"An index of all Audio Capture available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Audio Capture Blueprints:

Name	Description
Construct Local Media	Creates a media object that will be used in the Add Media To Room node input. Connect an `Audio Capture` or `Odin Audio Capture` object to it.
Get Capture Devices Available	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.
Get Current Audio Capture Device	Returns info on the current capture device.
Change Capture Device By Id	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.
Change Capture Device By Name	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.
Restart Capturing	Restart the stream, using CurrentSelectedDeviceIndex as the new input.
Get and Set Is Paused	Get Is Capturing Paused: Returns whether the audio capture is paused. Set Is Capturing Paused: Sets the paused state of the audio capture.
On Capture Device Reset	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.
On Default Device Changed	Will be called if the Default Device is the currently selected device and if the Default Device was switched by the system.

`}),e.add({id:3761,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-connection-state-changed/",title:"Bind to On Connection State Changed",section:"ODIN Documentation",description:"Listens to on `Connection State Changed` events from the given Room object and calls the connected event handler of type On Connection Changed .",content:`

Listens to on Connection State Changed events from the given Room object and calls the connected event handler of type On Connection Changed.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be checked. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect a On Connection State Changed Event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3762,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-media-added/",title:"Bind to On Media Added",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect to an On Media Added to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3763,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-media-removed/",title:"Bind to On Media Removed",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect to a On Media Removed event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3764,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-message-received/",title:"Bind to On Message Received",section:"ODIN Documentation",description:"Listens to On Message Received events in the given Room object. `On Message Received` events will be triggered whenever another peer has sent a message.",content:`

Listens to On Message Received events in the given Room object. On Message Received events will be triggered whenever another peer has sent a message.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect to a On Message Received event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3765,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-peer-joined/",title:"Bind to On Peer Joined",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect a Peer Joined Event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3766,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-peer-left/",title:"Bind to On Peer Left",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect to an On Peer Left Event to handle `Peer Left` event calls.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3767,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-peer-user-data-changed/",title:"Bind to On Peer User Data Changed",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect to a Peer User Data Changed Event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3768,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-room-joined/",title:"Bind to On Room Joined",section:"ODIN Documentation",description:"Listens on `Room Joined` events on the given Room object and calls the connected Room Joined Event handler.",content:`

Listens on Room Joined events on the given Room object and calls the connected Room Joined Event handler.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect a Room Joined Event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3769,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/bind-to-on-room-user-data-changed/",title:"Bind to On Room User Data Changed",section:"ODIN Documentation",description:"Bind to `Room User Data Changed` events in the given Room.",content:`

Bind to Room User Data Changed events in the given Room.

Inputs

Name	Type	Description
Exec	exec
Target	Room Object Reference	The Room for which events will be triggered. Use the Construct local room handle node to create that Room object reference.
Event	delegate	Connect an On Room User Data Changed Event to handle this event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3770,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/change-capture-device-by-id/",title:"Change Capture Device By Id",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
New Device Id	string	The id of the targeted capture device.
On Change Completed (Async Only)	delegate	Callback for when the change result is available. Used only in the async version.

Outputs

Name	Type	Description
Exec	exec
Success	boolean	Whether or not the capture device was successfully changed. This is for the synchronous version only.

`}),e.add({id:3771,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/change-capture-device-by-name/",title:"Change Capture Device By Name",section:"ODIN Documentation",description:"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.",content:`

Inputs

Name	Type	Description
Exec	exec
Device Name	name	The name of the targeted capture device. Needs to be an exact match.
On Change Completed (Async Only)	delegate	Callback for when the change result is available. Used only in the async version.

Outputs

Name	Type	Description
Exec	exec
Success	boolean	Whether or not the capture device was successfully changed. This is for the synchronous version only.

`}),e.add({id:3772,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/construct-a-token-generator/",title:"Construct a Token Generator",section:"ODIN Documentation",description:"Creates a token generator that is used to generate room tokens on client side. ",content:`

Creates a token generator that is used to generate room tokens on client side.

Important

It is ok for development and testing purposes to create room tokens on client side - but in production you should switch to server side generation of room tokens!

Inputs

Name	Type	Description
Access Key	string	The access key for generating room tokens. You need to get an access key by signing up to the service or create a test key by following our Getting Started guide.

Outputs

Name	Type	Description
Return Value	Token Generator	The constructed token generator object. Connect to Generate Room Token to generate a room token.

`}),e.add({id:3773,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/construct-local-media/",title:"Construct Local Media",section:"ODIN Documentation",description:"Creates a media object that will be used in the Add Media To Room node input. Connect an `Audio Capture` or `Odin Audio Capture` object to it.",content:`

Creates a media object that will be used in the Add Media To Room node input. Connect an Audio Capture or Odin Audio Capture object to it.

Important

Use the Create Audio Capture or Create Odin Audio Capture node to get access to the microphone on the users device. Make sure that the Audio Capture Plugin is enabled. You’ll find it in the Audio section of the Plugin Manager.

Inputs

Name	Type	Description
Audio Capture	Audio Capture Object Reference	The audio capture object reference.

Outputs

Name	Type	Description
Return Value	Odin Capture Media Object Reference	A reference to the constructed Odin Capture Media object.

`}),e.add({id:3774,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/construct-local-room-handle/",title:"Construct Local Room Handle",section:"ODIN Documentation",description:"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`.",content:`

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.

Inputs

Name	Type	Description
Initial APM Settings	APMSettings	The initial APM settings to use when constructing the room. Use the Make APM Settings node to create initial APM Settings.

Outputs

Name	Type	Description
Return Value	Room	The constructed room object.

`}),e.add({id:3775,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/create-odin-audio-capture/",title:"Create Odin Audio Capture",section:"ODIN Documentation",description:"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](https://docs.unrealengine.com/4.27/en-US/BlueprintAPI/AudioCapture/CreateAudioCapture/), like enabling capture device switching on supported platforms or improved Push-To-Talk features. Please make sure, that the `Audio Capture` Plugin is enabled.",content:`

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.

Outputs

Name	Type	Description
Return Value	Odin Audio Capture Object Reference	A reference to the constructed Odin Audio Capture object.

`}),e.add({id:3776,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/delegates/",title:"Delegates",section:"ODIN Documentation",description:"An index of all Delegates available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Delegates Blueprints:

Name	Description
Bind to On Connection State Changed	Listens to on `Connection State Changed` events from the given Room object and calls the connected event handler of type On Connection Changed.
Bind to On Room Joined	Listens on `Room Joined` events on the given Room object and calls the connected Room Joined Event handler.
Bind to On Room User Data Changed	Bind to `Room User Data Changed` events in the given Room.
Bind to On Peer Joined	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.
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 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.
Bind to On Media Added	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.
Bind to On Media Removed	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.
Bind to On Message Received	Listens to On Message Received events in the given Room object. `On Message Received` events will be triggered whenever another peer has sent a message.

`}),e.add({id:3777,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/destroy-local-room-handle/",title:"Destroy Local Room Handle",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The room object whose connection to the server will be closed and handle destroyed.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3778,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/",title:"Events",section:"ODIN Documentation",description:"An index of all Events available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Events Blueprints:

Name	Description
On Add Media To Room Success	This event is triggered in the Add Media To Room function once the media has been added to the room successfully.
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 Bind to On Connection State Changed delegate node to handle this event for the specified room.
On Room Joined	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.
On Room User Data Changed	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.
On Peer Joined	Called 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 Left	Called whenever a peer leaves the room. Connect to a Bind to On Peer Left node to handle this event for the specified room.
On Peer User Data Changed	Called whenever a peer has changed its user data. Connect to a Bind to On Peer User Data Changed node to handle this event for the specified room.
On Media Added	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.
On Media Removed	Called whenever a peer has removed a media stream. Connect to a Bind to On Media Removed delegate node to handle this event for the specified room.
On Message Received	Called whenever another peer has sent a message. Connect to a Bind to On Message Received delegate node to handle this event for the specified room.

`}),e.add({id:3779,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/format-error/",title:"Format Error",section:"ODIN Documentation",description:"Takes an ODIN error code and returns an error message a string which can be printed to the log. ",content:`

Takes an ODIN error code and returns an error message a string which can be printed to the log.

Inputs

Name	Type	Description
Code	integer	The error code.

Outputs

Name	Type	Description
Return Value	string	The error message for the code.

`}),e.add({id:3780,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/",title:"Functions",section:"ODIN Documentation",description:"An index of all Functions available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Functions Blueprints:

Name	Description
Construct Local Room Handle	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`.
Make ODIN APM Settings	Creates an APM settings object that can be used to construct a local room handle.
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.
Create Odin Audio Capture	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.
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.
Get and Set Volume Multiplier	GetVolumeMultiplier: Retrieves the current volume multiplier of the capture device’s input. SetVolumeMultiplier: Sets the volume multiplier for the capture device’s input.
Get and Set Max Volume Multiplier	GetMaxVolumeMultiplier: Retrieves the current maximum volume multiplier value. SetMaxVolumeMultiplier: Sets the new maximum volume multiplier value.

`}),e.add({id:3781,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/generate-access-key/",title:"Generate Access Key",section:"ODIN Documentation",description:"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.",content:`

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.

Important

Do not connect this node directly to the Generate Room Token node, as a new access key would be generated during each play session for each users. Instead, print the generated access key into a log and store it in a variable, connecting that variable with the Generate Room Token node.

Outputs

Name	Type	Description
Return Value	string	The access key for up to 25 peak concurrent users (PCU) per day. Connect to a log function to output the access key and then use that access key as input for the Generate Room Token node.

`}),e.add({id:3782,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/generate-room-token/",title:"Generate Room Token",section:"ODIN Documentation",description:"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´)",content:`

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´)

Inputs

Name	Type	Description
Exec	exec
Target	Token Generator	Use the Construct Token Generator node to generate a token generator.
Room Id	string	The room id to generate a token for. Every user connected to the same room can talk to each other and exchange data.
User Id	string	The user id to generate a token for. You can use any string that makes sense for you to connect Odin peers to your users.
Token Audience	enum	The enum value of the token audience. Possible values are `Default` (for using a gateway) or `Single Server` (for using a specific Odin server without a gateway).

Outputs

Name	Type	Description
Exec	exec
Return Value	string	Returns a room token that can be used to join a room.

`}),e.add({id:3783,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/get-and-set-is-paused/",title:"Get and Set Is Paused",section:"ODIN Documentation",description:"Get Is Capturing Paused: Returns whether the audio capture is paused. Set Is Capturing Paused: Sets the paused state of the audio capture.",content:`

Get Is Capturing Paused: Returns whether the audio capture is paused. Set Is Capturing Paused: Sets the paused state of the audio capture.

Tip

Use these Nodes, if you’d like to implement Push-To-Talk or Mute Functionality. The Is Paused state is optimized for this use case.

Inputs

Name	Type	Description
Is Capturing Paused	boolean	The new paused state to set. Only used in Set Is Capturing Paused.

Outputs

Name	Type	Description
Is Capturing Paused	boolean	The current paused state. Only used in Get Is Capturing Paused.

`}),e.add({id:3784,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/get-and-set-max-volume-multiplier/",title:"Get and Set Max Volume Multiplier",section:"ODIN Documentation",description:"GetMaxVolumeMultiplier: Retrieves the current maximum volume multiplier value. SetMaxVolumeMultiplier: Sets the new maximum volume multiplier value.",content:`

GetMaxVolumeMultiplier: Retrieves the current maximum volume multiplier value. SetMaxVolumeMultiplier: Sets the new maximum volume multiplier value.

Tip

This value will cap the Volume Multiplier value. The default value is 3.0.

Inputs

Name	Type	Description
Exec	exec
Target	OdinCaptureMedia	The Odin Capture Media object whose max volume multiplier is being retrieved or set.
Max Volume Multiplier	float	The new max volume multiplier value to set. Used only in SetMaxVolumeMultiplier.

Outputs

Name	Type	Description
Exec	exec
Max Volume Multiplier	float	The current maximum volume multiplier. Returned only by GetMaxVolumeMultiplier.

`}),e.add({id:3785,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/get-and-set-volume-multiplier/",title:"Get and Set Volume Multiplier",section:"ODIN Documentation",description:"GetVolumeMultiplier: Retrieves the current volume multiplier of the capture device's input. SetVolumeMultiplier: Sets the volume multiplier for the capture device's input.",content:`

GetVolumeMultiplier: Retrieves the current volume multiplier of the capture device’s input. SetVolumeMultiplier: Sets the volume multiplier for the capture device’s input.

Important

For security reasons, the volume multiplier is capped to the range [0, MaxVolumeMultiplier]. The maximum volume multiplier defaults to 3.0. To change the maximum volume multiplier, use the Set Max Volume Multiplier function.

Inputs

Name	Type	Description
Exec	exec
Target	OdinCaptureMedia	The Odin Capture Media object whose volume multiplier is being retrieved or set.
Volume Multiplier	float	The new volume multiplier to set. Used only in SetVolumeMultiplier.

Outputs

Name	Type	Description
Exec	exec
Volume Multiplier	float	The current volume multiplier. Returned only by GetVolumeMultiplier.

`}),e.add({id:3786,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/get-capture-devices-available/",title:"Get Capture Devices Available",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
On Result (Async Only)	delegate	Callback for when the result is available. Used only in the async version.

Outputs

Name	Type	Description
Exec	exec
Out Devices	Array of object	All available capture devices. This is the output for both synchronous and asynchronous versions.

`}),e.add({id:3787,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/get-connected-playback-media/",title:"Get Connected Playback Media",section:"ODIN Documentation",description:"Retrieves the playback media stream pointer that was assigned to this synth component.",content:`

Retrieves the playback media stream pointer that was assigned to this synth component.

Inputs

Name	Type	Description
Self	Odin Synth Component	The Odin Synth Component object to call this function on.

Outputs

Name	Type	Description
Return Value	Odin Playback Media	The connected Odin Playback Media object.

`}),e.add({id:3788,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/get-current-audio-capture-device/",title:"Get Current Audio Capture Device",section:"ODIN Documentation",description:"Returns info on the current capture device.",content:`

Returns info on the current capture device.

Outputs

Name	Type	Description
Current Device	OdinCaptureDeviceInfo	Info on the current capture device.

`}),e.add({id:3789,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/get-output-media-id/",title:"Get Output Media Id",section:"ODIN Documentation",description:"Get the media ID of an output media",content:`

Get the media ID of an output media

Inputs

Name	Type	Description
Self	Odin Playback Media	The Odin Playback Media object to call this function on.

Outputs

Name	Type	Description
Return Value	integer	The media ID of the Odin Playback Media object.

`}),e.add({id:3790,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/get-output-media-peer-id/",title:"Get Output Media Peer Id",section:"ODIN Documentation",description:"Get the peer ID of an output media",content:`

Get the peer ID of an output media

Inputs

Name	Type	Description
Self	Odin Playback Media	The Odin Playback Media object to call this function on.

Outputs

Name	Type	Description
Return Value	integer	The peer ID of the Odin Playback Media object.

`}),e.add({id:3791,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/get-output-media-stats/",title:"Get Output Media Stats",section:"ODIN Documentation",description:"Get statistics for an output media",content:`

Get statistics for an output media

Inputs

Name	Type	Description
Self	Odin Playback Media	The Odin Playback Media object to call this function on.

Outputs

Name	Type	Description
Return Value	Odin Audio Stream Stats	The Odin Audio Stream Stats of the Odin Playback Media object.

`}),e.add({id:3792,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/get-room-connection-stats/",title:"Get Room Connection Stats",section:"ODIN Documentation",description:"Get statistics for a room connection. This function provides detailed information about the connection status and metrics in an ODIN room.",content:`

Get statistics for a room connection. This function provides detailed information about the connection status and metrics in an ODIN room.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The Room object to call this function on.

Outputs

Name	Type	Description
Exec	exec
Connection Stats	OdinConnectionStats	The statistics for the room connection.

`}),e.add({id:3793,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/join-room/",title:"Join Room",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Room	Room	Connect the Room instance created by the Construct local room handle node. This room handle will later be used to handle events.
Url	string	The url to the ODIN gateway. Typically this is `https://gateway.odin.4players.io`.
Token	string	The token you created with the Generate Room Token node.
Initial Peer User Data	Array of byte	User data can be anything and will be associated with the user (peer) on ODIN servers. User Data is automatically synchronized with other users in the same ODIN room. This enables you to easily exchange data like names or IDs.
Initial Peer Position	vector	The initial peer position in Odin’s space. This value is used to optimize audio streams by not streaming audio data to peer’s that are outside of hearing range. Please refer to the Update Peer Position node for more information and to update the position later on.
On Error	delegate	Delegate to handle errors while joining a room. Most of the time, an error will occur when the room token is invalid or the room is full.
On Success	delegate	Called when the room has been successfully joined.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the gateway has returned its response. The `success` output indicates whether the room was successfully joined.
Success	boolean	`true` if the room has been successfully joined.

Discussion

Once you have joined the room, a sequence of events is created. You can learn more about these events here.

To handle these events create a Bind to .... node and connect that to your Room node created earlier in Construct local room handle node.

Info

If you cannot find the Bind to .... node (for example Bind to Room Joined Event), you need to disable the context filter in the blueprint node selection dialog.

`}),e.add({id:3794,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/make-odin-apm-settings/",title:"Make ODIN APM Settings",section:"ODIN Documentation",description:"Creates an APM settings object that can be used to construct a local room handle.",content:`

Creates an APM settings object that can be used to construct a local room handle.

Inputs

Name	Type	Description
Enable Voice Activity Detection	boolean	When enabled, ODIN will analyze the audio input signal using smart voice detection algorithm to determine the presence of speech. You can define both the probability required to start and stop transmitting.
Attack Probability	float	Voice probability value when the VAD should engage.
Release Probability	float	Voice probability value when the VAD should disengage. It’s recommended to keep this value 0.1 lower than the attack probability.
Enable Volume Gate	boolean	When enabled, the volume gate will measure the volume of the input audio signal, thus deciding when a user is speaking loud enough to transmit voice data. You can define both the root mean square power (dBFS) for when the gate should engage and disengage.
Attack Loudness (D BFS)	float	Root mean square power (dBFS) when the volume gate should engage.
Release Loudness (D BFS)	float	Root mean square power (dBFS) when the volume gate should disengage. It’s recommended to keep this value 10 lower than the attack loudness.
Echo Canceller	boolean	When enabled, aligns the original and the reverse audio stream to negate the output inside the input, resulting in effective echo cancellation
High Pass Filter	boolean	When enabled, the high-pass filter will remove low-frequency content from the input audio signal, thus making it sound cleaner and more focused.
Pre Amplifier	boolean	When enabled, the preamplifier will boost the signal of sensitive microphones by taking really weak audio signals and making them louder.
Noise Suppression	enum	When enabled, the noise suppressor will remove distracting background noise from the input audio signal. You can control the aggressiveness of the suppression. Increasing the level will reduce the noise level at the expense of a higher speech distortion.
Transient Suppression	boolean	When enabled, the transient suppressor will try to detect and attenuate keyboard clicks.
Gain Controller	boolean	When enabled, the gain controller will automatically bring the signal to an appropriate range. This means input signals with low volume will be amplified and high volume will be limited.

Outputs

Name	Type	Description
Return Value	APMSettings	The constructed APM settings object.

Discussion

Audio settings can sometimes be challenging to navigate, especially for those new to the field. While many options are straightforward, some require specific values to optimize performance.

In environments with high background noise, it’s essential to prevent this noise from being transmitted. To address this, we offer two key settings:

Voice Activity Detection

Our system utilizes a few milliseconds of audio to ascertain if the user is speaking by leveraging an advanced AI model. It’s recommended to keep this feature enabled.

The AI model operates on a probability scale ranging from 0.0 to 1.0, where 0.0 indicates zero likelihood of voice presence, and 1.0 signifies absolute certainty. Adjust the Attack and Release settings to define the probability thresholds for starting and stopping transmission.

Optimal settings are generally 0.9 for Attack (90% certainty of voice) and 0.8 for Release. We recommend setting the Release value slightly lower than the Attack value, ideally maintaining an offset of 0.1.

While effective in many scenarios, certain situations, like a bustling open-office, may require additional measures. In these cases, the AI might confidently detect voice, but it may not be the voice of the intended speaker.

Here, the Volume Gate filter proves useful:

Volume Gate

The Volume Gate operates by setting a volume threshold below which the microphone remains disabled. This helps distinguish between actual speech and lower-volume background noises. The gate activates only when the detected sound exceeds this threshold.

Understanding this concept might be initially complex. A useful resource is Wikipedia on DBFS.

It’s generally advisable to disable this feature initially. A starting points for settings could be -40 for Release and -30 for Attack. We recommend setting the Release value slightly lower than the Attack value, ideally maintaining an offset of 10. For further assistance, please feel free to contact our support team.

`}),e.add({id:3795,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/odin-assign-synth-to-media/",title:"Odin Assign Synth to Media",section:"ODIN Documentation",description:"Assign a media stream coming with the `Media Added` event to the `Odin Synth Component` which will generate audio output from the incoming stream.",content:`

Assign a media stream coming with the Media Added event to the Odin Synth Component which will generate audio output from the incoming stream.

Inputs

Name	Type	Description
Exec	exec
Target	Odin Synth Component Object Reference	The Odin Synth Component that you either get from an Actor using the `GetComponentByClass` node or from the Add Odin Synth Component node.
Media	Media Object Reference	The media stream to be assigned to the `Odin Synth Component`. You’ll get that from the Media Added event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3796,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/odin-assign-synth-to-media/",title:"Odin Assign Synth to Media",section:"ODIN Documentation",description:"Assign a media stream coming with the `Media Added` event to the `Odin Synth Component` which will generate audio output from the incoming stream.",content:`

Assign a media stream coming with the Media Added event to the Odin Synth Component which will generate audio output from the incoming stream.

Inputs

Name	Type	Description
Exec	exec
Target	Odin Synth Component	The Odin Synth Component that you either get from an Actor using the `GetComponentByClass` node or from the Add Odin Synth Component node.
Media	Media Object Reference	The media stream to be assigned to the `Odin Synth Component`. You’ll get that from the Media Added event.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3797,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/",title:"Odin Synth Component",section:"ODIN Documentation",description:"An index of all Odin Synth Component available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Odin Synth Component Blueprints:

Name	Description
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.
Reset Odin Media	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.
Adjust Attenuation	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.
Get Connected Playback Media	Retrieves the playback media stream pointer that was assigned to this synth component.
Get Output Media Stats	Get statistics for an output media
Get Output Media Id	Get the media ID of an output media
Get Output Media Peer Id	Get the peer ID of an output media
Resume Playback Media	Resume the specified playback media handle, re-initiating the reception of data.
Pause Playback Media	Pause the specified playback media handle, stopping the reception of data.

`}),e.add({id:3798,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-add-media-to-room-success/",title:"On Add Media To Room Success",section:"ODIN Documentation",description:"This event is triggered in the Add Media To Room function once the media has been added to the room successfully.",content:`

This event is triggered in the Add Media To Room function once the media has been added to the room successfully.

Inputs

Name	Type	Description
Delegate	delegate	Bind to a Add Media To Room `On Success` delegate node to get this event triggered once the media has been added to the room.

Outputs

Name	Type	Description
Exec	exec
Media Id	integer	The media id added to the room.

`}),e.add({id:3799,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/on-capture-device-reset/",title:"On Capture Device Reset",section:"ODIN Documentation",description:"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.",content:`

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.

Outputs

Name	Type	Description
Capture Device Change	delegate	A dynamic multicast delegate that is called when the capture device needs to be reset.

`}),e.add({id:3800,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-connection-state-changed/",title:"On Connection State Changed",section:"ODIN Documentation",description:"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.",content:`

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.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Onnection State Changed node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Bind to a Bind to On Connection State Changed delegate node to get this event triggered once the room has been joined.

Outputs

Name	Type	Description
Exec	exec
Connection State	enum	The enum value of the connection state. Possible values are `Disconnected`, `Disconnecting`, `Connecting`, `Connected`.
Room	Room Object Reference	The Room object reference for which the connection changed event occured.

`}),e.add({id:3801,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/on-default-device-changed/",title:"On Default Device Changed",section:"ODIN Documentation",description:"Will be called if the Default Device is the currently selected device and if the Default Device was switched by the system.",content:`

Will be called if the Default Device is the currently selected device and if the Default Device was switched by the system.

Outputs

Name	Type	Description
Capture Device Change	delegate	A dynamic multicast delegate that is called when the default capture device changes.

`}),e.add({id:3802,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-media-added/",title:"On Media Added",section:"ODIN Documentation",description:"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.",content:`

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.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Media Added node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Connect to a Bind to On Media Added delegate node to get this event triggered once a peer has added a media object.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that added the media.
Media	Media Object Reference	An object reference to the media added to the room for the peer. Assign this media object to an `Odin Synth Component` for audio to be played in-game.
Properties	Properties Object Reference	Properties of the media object.
Room	Room Object Reference	The Room object reference for which the event was triggered.

`}),e.add({id:3803,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-media-removed/",title:"On Media Removed",section:"ODIN Documentation",description:"Called whenever a peer has removed a media stream. Connect to a Bind to On Media Removed delegate node to handle this event for the specified room.",content:`

Called whenever a peer has removed a media stream. Connect to a Bind to On Media Removed delegate node to handle this event for the specified room.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Media Removed node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Bind to a Bind to On Media Removed delegate node to get this event triggered once a peer has removed a media object.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that removed the media.
Media	Media Object Reference	An object reference to the media removed from the room.
Room	Room Object Reference	The Room object reference that the media was removed from.

`}),e.add({id:3804,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-message-received/",title:"On Message Received",section:"ODIN Documentation",description:"Called whenever another peer has sent a message. Connect to a Bind to On Message Received delegate node to handle this event for the specified room.",content:`

Called whenever another peer has sent a message. Connect to a Bind to On Message Received delegate node to handle this event for the specified room.

Tip

Inputs

Name	Type	Description
Delegate	delegate	Connect to a Bind to On Message Received delegate node to get this event triggered when another peer sent a message.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that sent the message.
Data	Array of byte	The message payload data as an array of bytes.
Room	Room Object Reference	The Room object reference of the room the message was sent in.

`}),e.add({id:3805,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-peer-joined/",title:"On Peer Joined",section:"ODIN Documentation",description:"Called whenever a peer joins the room. Connect a Bind to On Peer Joined delegate node to handle this event for the specified room.",content:`

Called whenever a peer joins the room. Connect a Bind to On Peer Joined delegate node to handle this event for the specified room.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Peer Joined node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Bind to a Bind to On Peer Joined delegate node to get this event triggered once a peer has joined the room.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that joined the room. This is the `self` peer id, i.e. the peer id of the local player.
User Data	Array of byte	The user data of the peer as an array of bytes
Room	Room Object Reference	The Room object reference for which the event was triggered.

`}),e.add({id:3806,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-peer-left/",title:"On Peer Left",section:"ODIN Documentation",description:"Called whenever a peer leaves the room. Connect to a Bind to On Peer Left node to handle this event for the specified room.",content:`

Called whenever a peer leaves the room. Connect to a Bind to On Peer Left node to handle this event for the specified room.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Peer Left node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Connect to a Bind to On Peer Left delegate node to get this event triggered once a peer has left the room.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that joined the room.
Room	Room Object Reference	The Room object reference for which the event was triggered.

`}),e.add({id:3807,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-peer-user-data-changed/",title:"On Peer User Data Changed",section:"ODIN Documentation",description:"Called whenever a peer has changed its user data. Connect to a Bind to On Peer User Data Changed node to handle this event for the specified room.",content:`

Called whenever a peer has changed its user data. Connect to a Bind to On Peer User Data Changed node to handle this event for the specified room.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Peer User Data Changed node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Connect to a Bind to On Peer User Data Changed node to get this event triggered once a peer has left the room.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that joined the room.
User Data	Array of byte	The updated user data of the peer as an array of bytes.
Room	Room Object Reference	The Room object reference for which the event was triggered.

`}),e.add({id:3808,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-room-joined/",title:"On Room Joined",section:"ODIN Documentation",description:"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.",content:`

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.

Important

The resulting peer id is only valid in the context of this room. This event will only be called for the local user.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Room Joined node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Call the Bind to On Room Joined node to get this event triggered once the room has been joined.

Outputs

Name	Type	Description
Exec	exec
Peer Id	integer	The id of the peer that joined the room. This is the `self` peer id, i.e. the peer id of the local player. This peer id is only valid in the context of this room!
Room User Data	Array of byte	The user data stored in the room for the peer as an array of bytes.
Room	Odin Room Object Reference	The Odin Room to which the peer joined.

`}),e.add({id:3809,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/events/on-room-user-data-changed/",title:"On Room User Data Changed",section:"ODIN Documentation",description:"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.",content:`

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.

Tip

There might be issues if you create the event manually. Instead, drop a Bind to On Room User Data Changed node into the blueprint, drag out from Event until you see the red line. Then release the mouse button and in the drop down choose Add Custom Event. Unreal will create the correct event for you then.

Inputs

Name	Type	Description
Delegate	delegate	Connect to the Bind to On Room User Data Changed node to get this event triggered once a peer has left the room.

Outputs

Name	Type	Description
Exec	exec
User Data	Array of byte	The updated user data of the room as an array of bytes.
Room	Room Object Reference	The Room object reference for which the Room User Data was changed.

`}),e.add({id:3810,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/pause-playback-media/",title:"Pause Playback Media",section:"ODIN Documentation",description:"Pause the specified playback media handle, stopping the reception of data.",content:`

Pause the specified playback media handle, stopping the reception of data.

Inputs

Name	Type	Description
Exec	exec
Media	Odin Playback Media	The Odin Playback Media object to call this function on.
On Error	delegate	Delegate to handle errors while pausing a Odin Playback Media.
On Success	delegate	Called when the Odin Playback Media has been successfully paused.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the server has returned its response. The `success` output indicates whether the Odin Playback Media object was successfully paused.
Success	boolean	`true` Odin Playback Media object has been successfully paused.

`}),e.add({id:3811,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/reset-odin-media/",title:"Reset Odin Media",section:"ODIN Documentation",description:"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.",content:`

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.

Inputs

Name	Type	Description
Exec	exec
Target	Odin Synth Component	The Odin Synth Component to call this function on.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3812,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/audio-capture/restart-capturing/",title:"Restart Capturing",section:"ODIN Documentation",description:"Restart the stream, using CurrentSelectedDeviceIndex as the new input.",content:`

Restart the stream, using CurrentSelectedDeviceIndex as the new input.

Inputs

Name	Type	Description
Exec	exec
Automatically Start Capture	boolean	If true, the capture will automatically start. Defaults to true.

Outputs

Name	Type	Description
Exec	exec
Return	boolean	Returns true if the capturing restarts successfully.

`}),e.add({id:3813,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/odin-synth-component/resume-playback-media/",title:"Resume Playback Media",section:"ODIN Documentation",description:"Resume the specified playback media handle, re-initiating the reception of data.",content:`

Resume the specified playback media handle, re-initiating the reception of data.

Inputs

Name	Type	Description
Exec	exec
Media	Odin Playback Media	The Odin Playback Media object to call this function on.
On Error	delegate	Delegate to handle errors while resuming a Odin Playback Media.
On Success	delegate	Called when the Odin Playback Media has been successfully resumed.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the server has returned its response. The `success` output indicates whether the Odin Playback Media object was successfully resumed.
Success	boolean	`true` Odin Playback Media object has been successfully resumed.

`}),e.add({id:3814,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/",title:"Room",section:"ODIN Documentation",description:"An index of all Room available in our Unreal Engine Plugin",content:`

Our Unreal Engine Plugin contains these Room Blueprints:

Name	Description
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.
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.
Set Room Position Scale	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.
Update Peer Position	Updates the position of the own peer in the room. You have to set the scale beforehand via Set Room Position Scale.
Send Message	Sends 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.
Get Room Connection Stats	Get statistics for a room connection. This function provides detailed information about the connection status and metrics in an ODIN room.
Set Room APM Config	Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.
Set Room APM Stream Delay	Updates the delay estimate in ms for reverse stream used in echo cancellation. This function modifies the delay settings for a specific room.
Destroy Local Room Handle	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.

`}),e.add({id:3815,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/send-message/",title:"Send Message",section:"ODIN Documentation",description:"Sends 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.",content:`

Sends 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.

Tip

Use Bind to On Message Received node to receive messages sent from other peers.

Inputs

Name	Type	Description
Exec	exec
Room	Room	The room in which the message is sent.
Targets	Array of int64	List of targeted peer ids. If not specified, the message will be sent to all other peers in the same room.
Data	Array of byte	Message data can be anything. This enables you to easily exchange data between peers directly over the Odin server.
On Error	delegate	Delegate to handle errors when sending a message.
On Success	delegate	Called when the message has been successfully sent.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the server has returned its response. Use the `success` value to check if the message has been successfully sent.
Success	boolean	`true` if the message has been successfully sent.

`}),e.add({id:3816,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/functions/set-room-apm-config/",title:"Set Room APM Config",section:"ODIN Documentation",description:"Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.",content:`

Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The room object where the audio processing settings will be updated.
APM Config	FOdinApmSettings	The audio processing settings to be applied.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3817,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/set-room-apm-config/",title:"Set Room APM Config",section:"ODIN Documentation",description:"Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.",content:`

Updates audio processing settings for capture media handles in a specific room. This function allows modification of various audio processing parameters for a room.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The room object where the audio processing settings will be updated.
APM Config	FOdinApmSettings	The audio processing settings to be applied.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3818,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/set-room-apm-stream-delay/",title:"Set Room APM Stream Delay",section:"ODIN Documentation",description:"Updates the delay estimate in ms for reverse stream used in echo cancellation. This function modifies the delay settings for a specific room.",content:`

Updates the delay estimate in ms for reverse stream used in echo cancellation. This function modifies the delay settings for a specific room.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The room object where the APM stream delay will be updated.
Delay In Ms	int64	The delay estimate in milliseconds for the reverse stream used in echo cancellation.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3819,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/set-room-position-scale/",title:"Set Room Position Scale",section:"ODIN Documentation",description:"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.",content:`

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.

Important

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.

Inputs

Name	Type	Description
Exec	exec
Target	Room	The room for which the scale should be set.
Scale	float	The value of the scale as float.

Outputs

Name	Type	Description
Exec	exec

`}),e.add({id:3820,href:"https://www.4players.io/odin/sdk/unreal/blueprint-reference/room/update-peer-position/",title:"Update Peer Position",section:"ODIN Documentation",description:"Updates the position of the own peer in the room. You have to set the scale beforehand via Set Room Position Scale .",content:`

Updates the position of the own peer in the room. You have to set the scale beforehand via Set Room Position Scale.

Important

Invoking this method too frequently can lead to operational issues where the optimization of audio streams may not function correctly. Limit the frequency of calling Update Peer Position to a maximum of 10 times per second.

Tip

This function is optional and only used for performance reasons and to save bandwidth. This is not needed to make spatial audio work.

Inputs

Name	Type	Description
Exec	exec
Room	Room	The room in which the peer’s position shall be set.
Position	vector	The value of the position.
On Error	delegate	Delegate to handle errors while updating the position.
On Success	delegate	Called when the position has been successfully updated.

Outputs

Name	Type	Description
Exec	exec
On Response	exec	Called when the server has returned its response. Use the ‘success’ value to check if the position has been successfully set.
Success	boolean	`true` if the position has been successfully set.

`}),e.add({id:3821,href:"https://www.4players.io/examples/odin/sdk/unity/classes/messagereceivedproxy/",title:"",section:"Examples",description:"",content:`

`}),e.add({id:3822,href:"https://www.4players.io/examples/odin/sdk/unreal/blueprint-reference/join-room/",title:"",section:"Examples",description:"",content:`

Once you have joined the room, a sequence of events is created. You can learn more about these events here.

To handle these events create a Bind to .... node and connect that to your Room node created earlier in Construct local room handle node.

Info

If you cannot find the Bind to .... node (for example Bind to Room Joined Event), you need to disable the context filter in the blueprint node selection dialog.

`}),e.add({id:3823,href:"https://www.4players.io/examples/odin/sdk/unreal/blueprint-reference/make-odin-apm-settings/",title:"",section:"Examples",description:"",content:`

Audio settings can sometimes be challenging to navigate, especially for those new to the field. While many options are straightforward, some require specific values to optimize performance.

In environments with high background noise, it’s essential to prevent this noise from being transmitted. To address this, we offer two key settings:

Voice Activity Detection

Our system utilizes a few milliseconds of audio to ascertain if the user is speaking by leveraging an advanced AI model. It’s recommended to keep this feature enabled.

Here, the Volume Gate filter proves useful:

Volume Gate

Understanding this concept might be initially complex. A useful resource is Wikipedia on DBFS.

`}),e.add({id:3826,href:"https://www.4players.io/examples/odin/sdk/unity/classes/odinhandler/addplaybackcomponent/",title:"AddPlaybackComponent",section:"Examples",description:"AddPlaybackComponent Example",content:`

graph LR;
    subgraph Unity Scene
        subgraph Player1 [Player 1]
            PBC1[PlaybackComponent]-->GO1[GameObject]                   
        end
        subgraph Player2 [Player 2]
            PBC2[PlaybackComponent]-->GO2[GameObject]
        end
        
    end
    subgraph ODON Server
        subgraph ODIN Room
            Peer1[Peer 1] --> PBC1
            Peer2[Peer 2] --> PBC2
        end    
    end    
    classDef blue fill:#DDFAFF
    class Player1,Player2 blue

`}),e.add({id:3827,href:"https://www.4players.io/categories/",title:"Categories",section:"Categories",description:"",content:""}),e.add({id:3828,href:"https://www.4players.io/odin/sdk/swift/classes/",title:"Classes",section:"ODIN Documentation",description:"Classes for Swift iOS/iPadOS/macOS/tvOS/watchOS SDK",content:`

OdinAccessKey

OdinAudio

OdinManager

OdinMedia

OdinPeer

OdinRoom

OdinToken

`}),e.add({id:3829,href:"https://www.4players.io/fleet/cli/",title:"CLI Tool",section:"ODIN Fleet Documentation",description:"Get started with ODIN Fleet CLI and deploy your first game server.",content:`

ODIN Fleet provides a simple to ease CLI tool that allows you to interact with ODIN Fleet from your command line. It’s open-source and written in Deno and uses the TypeScript ODIN SDK internally.

Source Code

The CLI tool is open-source and available on GitHub. You can find the source code in the following repository: https://github.com/4Players/fleet-cli.

Installation

To install the CLI tool, you need to have Deno installed. You can install Deno by following the instructions on the official Deno website: https://deno.land/.

Next, run the following command to generate the CLI tool:

deno task build

This will build a odin binary (or odin.exe on Windows) in the root of the project. You can move this binary to a directory in your PATH to use it globally. On macOS and Linux you might need to run the following command to make the binary executable:

chmod +x odin

Development

You need to have npm installed on your system. You can install it by following the instructions on the official npm website: https://www.npmjs.com/get-npm.

If you want to work on the CLI tool, you can need to have openapi-generator-cli installed on your system. You can install it by running the following command:

npm install @openapitools/openapi-generator-cli -g

On Mac you can also use Homebrew to install the openapi-generator-cli.

openapi-generator-cli version-manager set 7.3.0

Updating the underlying SDK

To update the underlying SDK, you need to run the following command to make the script executable (if not done before):

chmod +x generate-sdk.sh

Then run the script to generate the SDK:

./generate-sdk.sh

This will generate the SDK from the OpenAPI specification file. The generated SDK will be placed in the src/api directory. The CLI tool uses this SDK to interact with the ODIN APIs.

Testing the CLI tool

To run the CLI tool in development mode, you can run the following command:

deno run --allow-all src/main.ts

We use --allow-all because the CLI tool needs to access various system resources to work correctly:

--allow-read to read the configuration file
--allow-write to write the configuration file
--allow-net to make API requests
--allow-env to read environment variables

Building the CLI tool

To build the CLI tool, you can run the following command:

deno task build

This will create a binary executable (i.e. odin on macOS and odin.exe on Windows) in the root of the project. You can move this binary to a directory in your PATH to use it globally.

`}),e.add({id:3830,href:"https://www.4players.io/fleet/guides/cli/",title:"CLI Tool",section:"ODIN Fleet Documentation",description:"Get started with ODIN Fleet CLI and deploy your first game server.",content:`

> odin fleet servers list
ID Region       City      Server Config        Address        Ports            Created  Status  
21 europe       limburg   Minecraft Production 51.77.85.52    Game Port: 30097 5.7.2024 running 
22 europe       limburg   Minecraft Production 51.77.85.52    Game Port: 30098 5.7.2024 running 
24 northamerica newyork   Minecraft Production 67.220.85.3    Game Port: 30100 5.7.2024 running 
25 asia         singapore Minecraft Production 15.235.216.107 Game Port: 30101 5.7.2024 running 
26 northamerica seattle   Minecraft Production 38.89.70.30    Game Port: 30102 5.7.2024 starting
Please note: Servers in intermediate states (e.g. starting, stopping) are not shown here.
> |

ODIN Fleet provides a simple to ease CLI tool that allows you to interact with ODIN Fleet from your command line. It’s written in Deno and uses the TypeScript ODIN Fleet SDK internally.

Warning

The CLI tool is still in development and new features are added regularly. If you have any feedback or feature requests, please let us know. We are also working on a simpler way to install the CLI tool globally.

Installation

Our CLI tool is open-source and available on GitHub. You can clone the repository and build the CLI tool yourself. We are working on providing pre-built binaries for all platforms.

Github Repository: https://github.com/4Players/fleet-cli

To install the CLI tool, you need to have Deno installed. You can install Deno by following the instructions on the official Deno website: https://deno.land/. Clone the repo on your workstation and navigate to the project directory.

git clone https://github.com/4Players/fleet-cli.git
cd fleet-cli

Next, run the following command to generate the CLI tool:

deno task build

chmod +x odin

Development

You need to have npm installed on your system. You can install it by following the instructions on the official npm website: https://www.npmjs.com/get-npm.

If you want to work on the CLI tool, you can need to have openapi-generator-cli installed on your system. You can install it by running the following command:

npm install @openapitools/openapi-generator-cli -g

On Mac you can also use Homebrew to install the openapi-generator-cli.

openapi-generator-cli version-manager set 7.3.0

Updating the underlying SDK

To update the underlying SDK, you need to run the following command to make the script executable (if not done before):

chmod +x generate-sdk.sh

Then run the script to generate the SDK:

./generate-sdk.sh

This will generate the SDK from the OpenAPI specification file. The generated SDK will be placed in the src/api directory. The CLI tool uses this SDK to interact with the ODIN APIs.

Testing the CLI tool

To run the CLI tool in development mode, you can run the following command:

deno run --allow-all src/main.ts

We use --allow-all because the CLI tool needs to access various system resources to work correctly:

--allow-read to read the configuration file
--allow-write to write the configuration file
--allow-net to make API requests
--allow-env to read environment variables

Building the CLI tool

To build the CLI tool, you can run the following command:

deno task build

Usage

The CLI tool is designed to work in two scenarios:

You are working in a terminal and can interact with the CLI tool (it will prompt for all missing information)
You are running the CLI tool in a CI/CD pipeline and need to provide all the necessary information as arguments

Logging in and selecting an application

First, you need to login to the ODIN API. You can do this by running the following command:

odin login

You will be prompted to enter a valid access token. You can get an access token by logging into the dashboard, navigating to the settings section (click on the user profile at the top right and choose Settings from the drop-down menu). You will find the access token in the API section.

Copy an access token that you have generated and paste it into the terminal. The CLI tool will store the access token in a configuration file in your home directory (~/.odin/config.json).

You can also provide the access token as an argument to all commands (this overrides the stored access token and is useful in CI/CD scripts where you cannot prompt the user)

odin fleet images list --accessToken=<access-token>

Next, you need to select an application to work with. You can list all the applications by running the following command:

odin apps list

You will see a list of applications that you have access to. You can select an application by running the following command:

odin apps select

You can also provide an application ID as an argument to all commands (this overrides the selected application and is useful in CI/CD scripts where you cannot prompt the user)

odin fleet images list --appId <application-id>

Working with the CLI tool

The CLI tool is designed to work with the ODIN APIs. You can list, create, update, and delete resources using the CLI tool. The CLI tool is designed to be self-explanatory, and you can get help by running the following command:

odin --help

You can also get help for a specific command by running the following command:

odin fleet --help
odin fleet images --help

Available Resources

The following resources are available in the CLI tool:

apps - List, select, and create applications
fleet - Manage ODIN Fleet resources
fleet images - List, create, update, and delete ODIN Fleet images
fleet configs - List, create, update, and delete ODIN Fleet server configurations
fleet deployments - List, create, update, and delete ODIN Fleet deployments
fleet servers - List, and work with ODIN Fleet servers that have been deployed

Use the --help flag to get more information about each resource and the available commands.

Automation

You can run commands that create, delete or update resources with the --dry-run flag. This will show you the API request that will be made without actually making the request. This is useful to see what the CLI tool will do before actually doing it and it also allows you to copy the API request and run it manually (and slightly modified) if needed. This way you can quickly create scripts for CI/CD. Manually interact with the CLI in --dry-run mode and then use the --payload= flag to run the same command with the payload you want to use.

Example

In this example we will create a new image for the ODIN Fleet. We will first run the command in --dry-run mode to see what the API request will look like:

odin fleet images create --dry-run

The CLI will prompt for various information like the image name, description and which type of image to create. After entering all the information, the CLI will show you the payload that will be sent to the API. You can copy this payload and run the following command:

odin fleet images create --payload='{"name":"my-image","version":"0.4.2","type":"dockerImage",....}}'

`}),e.add({id:3832,href:"https://www.4players.io/company/",title:"Companies",section:"Companies",description:"",content:""}),e.add({id:3833,href:"https://www.4players.io/partials/connection-event-summary/unity/",title:"Connection Event Summary",section:"Partials",description:"",content:`

Local	Remote	Description
OnRoomJoin		Triggered if user started to join a room
OnRoomJoined	OnPeerJoined	Triggered if user joined a room

class MyVoiceHandler: MonoBehaviour
{
  public string RoomName = "default";
  
  // Start is called before the first frame update
  void Start()
  {
    OdinHandler.Instance.JoinRoom(RoomName);
  }
}

`}),e.add({id:3834,href:"https://www.4players.io/partials/disconnect-event-summary/unity/",title:"Disconnect Event Summary",section:"Partials",description:"",content:`

Local	Remote	Description
OnRoomLeave		Triggered if user started to leave a room
OnRoomLeft	OnPeerLeft	Triggered if user left a room

`}),e.add({id:3835,href:"https://www.4players.io/odin/sdk/swift/enums/",title:"Enums",section:"ODIN Documentation",description:"Enums for Swift iOS/iPadOS/macOS/tvOS/watchOS SDK",content:`

OdinAudioAutopilotMode

OdinCustomData

OdinGatewayUrl

OdinResult

`}),e.add({id:3836,href:"https://www.4players.io/examples/",title:"Examples",section:"Examples",description:"",content:""}),e.add({id:3837,href:"https://www.4players.io/fleet/cli/fleet/",title:"Fleet",section:"ODIN Fleet Documentation",description:"Learn how to authenticate the ODIN CLI with your API key.",content:`

ODIN Fleet is a cloud-based platform that allows you to deploy and manage your gameservers and services. The ODIN CLI provides a set of commands that allow you to interact with the ODIN Fleet API from the command line.

Overview

The fleet commands allow you to manage your ODIN Fleet resources. These include images, configurations, deployments, and servers.

Usage

odin fleet <command>

Commands

Images: Manage images in your account.
Configs: Manage configurations in your account.
Deployments: Manage deployments in your account.
Servers: Manage servers in your account.

`}),e.add({id:3838,href:"https://www.4players.io/4netplayers/",title:"Free Server Hosting",section:"Free Server Hosting",description:"Get your game servers hosted for free world-wide and allow your community to host their own game servers",content:`

4Players is famous for its game server hosting brand 4Netplayers for more than two decades. Gamers can run their own game servers and decide if they want to run them public or private and decide settings themselves.

4Netplayers today has more than 300 games available in the library. Gamers can create and run gameservers immediately for any of these games, which include hit games like Valheim, Minecraft, Battlefield and many more.

Add your game to our library to allow your community to create gameservers for your game. Allow your community to play your game on servers they own, giving them more fun and more possibilities to play your game. 4Netplayers also supports mods giving your community even more fun with your game.

How it works

If you add your game to our library, we won’t charge you for any game server that is running. However, the community will be charged by us depending on the various pricing models. In this mode, your community will be building at least part of your game server fleet. However, that still requires some official game servers hosted by you as the community needs to have a place to start playing in the first place until they want to have their own servers.

If you add a button “Get your own server” directly in your game, bringing your players directly to our game server sales page you’ll even get a revenue share model for every gameserver that is being sold ingame.

Background

You have two options to deploy a game server with ODIN Fleet:

Docker Image: You can create your own Docker image and deploy it with ODIN Fleet.
Steamworks: You can deploy a game server using Steamworks.

In this case, we’ll use the excellent itzg/minecraft-server Docker image to deploy a Minecraft server.

Let’s get started…

Our dashboard is an easy way of managing your game servers and applications. It’s also a good way to see which items are created by the examples and how they are structured. Navigate to the dashboard at https://console.4players.io. All you need is a 4Players account which you can also create on the dashboard.

Once you have signed in, you need to create an application. An application is a space within ODIN Fleet that has its own resource limits and configurations. You can create multiple applications to separate different environments or projects.

Create an application

Once you have signed in into the dashboard you’ll be on the “Manage Apps” page. Click on the Create App button to create a new application. You can name it whatever you want, but for this example we’ll name it Minecraft.

Info

If you don’t want to follow the tutorial step by step we have made a shortcut for you: You can also install a demo application that will create all the necessary resources for you via script. Instead of clicking on the Create App button, click on the Create Demo App button. Choose Minecraft from the list, give it a name and click on Create.

Once you have created the application, you’ll be routed to the apps dashboard. Click on Fleet in the left sidebar to choose the Fleet product. In the sidebar you can also choose Voice which is our real-time voice-chat SDK with deep game engine integration to Unity and Unreal, but for now we’ll concentrate on gameserver deployment.

Create an image

Next step is to register an image. An image is a snapshot of your gameserver that can be deployed to a server. You can create an image from a Docker image or from a Steamworks app. As discussed earlier we’ll be using an existing docker image for Minecraft.

On the left side click on Images and then on Create Image. This is a three step process.

Provide basic image details like it’s name, version and underlying operating system.
Choose weather to provide a docker image or Steamworks credentials to create the image.
Enter the necessary information for the chosen image type.

This gallery shows you which data to enter and in written so that you can easily Copy & Paste from here:

Data to enter:

Name: Minecraft Tutorial
Version: 2024.6.1
Operating System: Linux
Image Type: Docker Image
Image Name: itzg/minecraft-server:2024.6.1
Registry: Docker Hub anonymous (default)

The minecraft docker images are tagged with the version number. This way we make sure that we have a specific version of the image. I.e. if the server restarts or changes the underlying machine (i.e. in case of a defekt of the machine) the docker image is still the same and not changes implicitly by the docker registry.

You also need to choose a docker registry from the list. In this case we choose Docker Hub which is the public registry of docker images. If you have your own registry you can choose that one (of course creating it before).

Info

Of course, we could also create an image that is always the latest version, but this is not recommended for production environments. It’s rather recommended to create new images within ODIN Fleet for each new version of your gameserver. This gives much better control. You’ll find more of these topics in the guides section.

Next, we’ll need to create the server config. This is the most complex part as in this step you define everything that defines your gameserver. Many games have different modes, maps, mods, etc. and you can define all of that here.

Creating a server configuration

Navigate to Server Configs in the left sidebar and click on Create Config. You’ll see a fairly complex editor but we’ll guide you through it.

Info

As there are a lot of settings you might risk to loose your data if you don’t save it. We have implemented a feature that will constantly (on any change) store the current settings in your browsers local storage. If you accidentally close the browser or tab you can just open the tab again you’ll be notified that there are unsaved changes and you can restore them.

Basic information

In the first part of the editor, you can provide basic information about the image like it’s name and which image should be used in this server configuration. Later, when you want to deploy a new version of your gameserver, all you need to do is to change the image of the server configuration and then that image will be rolled out in all deployments using this server configuration. We’ll come to that later.

So, let’s enter this data into the first couple of fields:

Name: Minecraft Tutorial
Image: Minecraft Tutorial (the image we have just created)
Restart: Always

You can leave out CMD and Entrypoint empty. This allows you to override the fields from the docker image, i.e. if you want to start a different entrypoint script than defined in the docker container. This can be very useful for development but is typically not used in production.

Scrolling down a bit and you’ll see a block with tabs and quite a lot of settings. We go through them one by one.

Ports

Setting up ports is very important if your server should be reached from the public internet. Within the container, which encapsulates the gameserver from everything else, you can define which ports should be exposed to the outside world. In this case, we need to expose the Minecraft port 25565 and it needs to TCP.

For every port that you define here our runtime will assign an available port and map that to the internal port. This way you can run multiple gameservers on the same machine without port conflicts.

This diagrams shows what’s going on under the hood. It shows multiple containers (i.e. gameservers running in docker containers) and how they are mapped to the public internet. Container 4 has two ports described in the server config and as such two ports are published to the internet.

flowchart TB
    Internet((Internet))
    
    subgraph Machine
        direction LR
        P1["Published Port 30001"] --> G1
        P2["Published Port 30002"] --> G2
        P3["Published Port 30003"] --> G3
        P4["Published Port 30004"] --> G4
        P5["Published Port 30005"] --> G5
        P6["published Port 30006"] --> R4
        
        subgraph Gameserver1["Container 1"]
            direction TB
            G1["Gameserver Port 25565"]
        end
        subgraph Gameserver2["Container 2"]
            direction TB
            G2["Gameserver Port 25565"]
        end
        subgraph Gameserver3["Container 3"]
            direction TB
            G3["Gameserver Port 25565"]
        end
        subgraph Gameserver4["Container 4"]
            direction TB
            G4["Gameserver Port 25565"]
            R4["RCON Port 25566"]
        end
        subgraph Gameserver5["Container 5"]
            direction TB
            G5["Gameserver Port 25565"]
        end
    end

    Internet --> |Port 30001| P1
    Internet --> |Port 30002| P2
    Internet --> |Port 30003| P3
    Internet --> |Port 30004| P4
    Internet --> |Port 30005| P5
    Internet --> |Port 30006| P6

Resources

In the next tab we need to define the resources that we want to allow this gameserver to consume. This is very important as it defines how much of the underlying machine the gameserver can use. For Minecraft as Small tier with 1 CPU and 2 GB RAM is enough. If you don’t know what to choose, we suggest to start with a higher tier, run the server through its paces and then check the stats (described later) to see the peak usage of the server. You should always choose a tier that has a bit of spare but not too much. If you have too much spare, you are wasting money. If you have too little, the server might be slow or even crash. We’ll do an experiment in another guide.

Info

We have two types of resources: Shared and Dedicated. Shared resources are shared between all gameservers on the machine. Our backend tries to minimize the “noisy neighbour” problem but that is not always easy to do. If you decide to use shared resources, we might “overbook” the machine a bit. This means that we might assign more resources to the gameservers than the machine actually has. This is not a problem as long as the gameservers don’t use all the resources at the same time. If they do, the machine might become slow and the gameservers might crash. This is why we have the dedicated resources. If you choose dedicated resources, the resources are reserved for your gameserver and no other gameserver can use them. This is more expensive but also more reliable.

Environment Variables

The next very important part are environment variables. Many gameservers are configured via environment variables. This is also the case for the Minecraft server. The Minecraft server has a lot of environment variables that you can set. Only one is really required: EULA. However, in this tutorial we have defined a bit more as that also shows why we have server configuration. In this example we have set the DIFFICULTY to hard. You might have another server config that is soft and this way you can deploy different server configurations with different settings.

There are two types of variables:

Static: These are variables that have a fixed value. This is the most common type of variable.
Dynamic: These are variables that are calculated at runtime. This is not used very often but can be very powerful.

Sometimes your gameserver might need to know on which IP and port it is running, i.e. for telemetry or to connect to a database. In this case you can use dynamic variables. You ca create a dynamic variable and set the type to “Port”. Then choose the game port that you have defined earlier. At runtime the environment variable will have the value of the published port. The same applies to the IP address which is also a dynamic variable.

Config Files

There is not much to do here for Minecraft. But instead of configuring your gameserver with environment variables you can also just use a config file. You define the content of the config file in the Dashboard and it will then be mounted into the specified path and filename in the container.

Secret Files

These are basically the same as config files, but these are encrypted. This is useful if you have a config file that contains sensitive data like passwords or API keys. You can create a secret file and then use it in the same way as a config file.

Mounts

Minecraft is a stateful server. This means that it stores data on the disk. This data is important and should not be lost. In this case, we mount a volume to the /data folder in the container. This way the data is stored on the host machine and not in the container. This is important as the container can be deleted at any time and the data would be lost.

Saving and moving on

Click on Save (scroll up) to save the server config. Next, we can finally deploy our configures server to the world.

Creating a Deployment

Navigate to Deployments on the left side. You’ll notice a world map where you can see all available locations where you can deploy your gameserver. Click on Add Deployment to start the process.

You’ll need to enter a few details:

Name: Minecraft Tutorial (This is the name of the deployment to keep track of it)
Location: Limburg (Choose the location where you want to deploy the gameserver)
Config: Minecraft Tutorial (This is the server config that you have created earlier)
Auto-Scaler: Off (This is a feature that automatically scales the deployment based on the number of players. We’ll come to that later)
Num Instances: 1 (This is the number of servers that you want to deploy)

Info

When creating a deployment a cost estimation is displayed which is based on the resources you have chosen. This is only an estimation and the actual costs might be different. You can also see the costs in the dashboard.

After you saved your deployments the screen changes a bit and shows the deployment that we have created just yet.

That’s it. ODIN Fleet will do the rest. Depending on your restart settings (we had it on Always) you will not have to do anything. No babysitting, no cost control, no manual restarts. ODIN Fleet will take care of everything.

Monitoring

You can monitor your deployment in the dashboard. You can see the state of the server, the logs, the resources used and much more. You can also create backups of the persistent folders that you have defined in the server config.

First, let’s navigate to Analytics. Here you can see how many servers ran throughout the billing period, within the last hours, etc. It’s an easy to use cost control as this is what we charge you. The peak number of running instances per day.

As you can see, it’ll show one instance running.

But, we want to dig deeper and understand which servers have been deployed and how many resources they are consuming. Click on Servers on the sidebar and you’ll see a list with all running servers from all deployments. Click on the server to see more details.

Click on the (i) icon on the right side of the list to reveal more details of the specific server. You can see the logs, the resources used, the environment variables, the mounts and much more. Click through the gallery to see some screenshots of that.

Checking server stats

Let’s get to the server stats and see how much resources the server is using. Click on the Stats tab to see the resource usage of the server. You can see the CPU, Memory, Disk and Network usage. This is very important to determine if the server is running smoothly or if it needs more resources.

As you can see, CPU is using the core available (we have set it to one) at the beginning to 1 and then drops to 0.1. Which means the average load is 10%. Memory slowly moves up to 820 MB which is 40% of the available memory. It seems that we could reduce the resources. Let’s fire up our Minecraft client and connect to the server to see if stats are changing if the server has something todo.

Connect to the server

In the Info tab you can see the IP address and the port of the server. You can use this information to connect to the server. In this case, we have a Minecraft server running on 51.77.85.52:30121.

In the Minecraft game I choose Multiplayer and click on Add Server. I enter the IP and the port like this:

After clicking on Done you’ll see the server in the list (I have highlighted the server that I just added):

Click on Join Server and you’ll be right in Minecraft and can start playing. Yes, you have deployed your own Minecraft within a few minutes!

Checking server stats again

Let’s run around a bit on the server, create and remove some blocks. After a couple of minutes playing, let’s check our Server Stats again:

Let’s see what we have here:

CPU is now at 1 which is quite different to before. The CPU is at 100%, which does not mean that we need to have more CPU. But we should test the server with more players to see if the CPU is the bottleneck.
Memory is now at 1053 MB which is 52% of the available memory. However, it’s more than 1024 MB that we would have in the Tiny tier. So, it’s very likely that the server will crash and in fact if you change the tier to Tiny the server will crash after a short period of playtime. Feel free to try it out.
Network Egress (i.e. server sending data) is expected and is not a problem. The server is sending data to the clients and this is what we want.
Data Write is expected, too. The server is writing data to the disk. This is the world data that is stored on the disk.

This way you can easily determine the resources required by your gameserver and adjust the resources accordingly.

Scale Up or Down

Let’s say you need another set of servers in the USA and you need to scale up the servers in Germany to handle the load. You can easily do that by scaling the deployment. Navigate to the deployment in Limburg and click on Edit. You can change the number of instances and click on Save.

Next, click on Add Deployment and add 1 Server in Seattle (USA). You can also choose another location if you want. After that, your servers list in the Servers part of the Dashboard will look like this:

You can see that we have 2 servers in Limburg and 1 server in Seattle.

Info

It depends on how you do any up- or downscaling. We have customers that review weekly the usage of their servers and scale them up or down manually in the Dashboard. We have others that have a fixed number of servers and only scale them up if they see that the servers are overloaded. And we have customers that have written scripts that automatically check the load of the servers and scale them up or down via script using our Fleet CLI or within a script using one of our SDKs (i.e. NodeJS).

Cost Control

After scaling up and waiting for 1 or 2 minutes (until servers are up and running) navigate back to Analytics. You’ll see that the number of running instances has increased. You can also see the costs of the deployment.

That is basically all there is for cost control. No hidden costs, no super complex charts, tables with hundreds of non-understandable invoice positions with literally no chance to understand what you are paying for. With us it’s simple, in this case we would charge you the 3 instances running today, if it’s a Small tier it would be 0.43€ per instance per day, i.e. in this case we would charge you 1,29€ for this day and 38,7€ per month. That’s it, that’s the price.

Clean Up

Navigate to the Deployments and remove the deployments. This will stop the servers and remove all resources that are associated with the deployment.

Next Steps

This was a very basic example of how to deploy a Minecraft server with ODIN Fleet. You can now start to experiment with different server configurations, different images, different locations, etc. You can also start to automate the deployment process with our API or CLI.

`}),e.add({id:3844,href:"https://www.4players.io/examples/odin/sdk/unity/getting-started-unity/",title:"Getting Started with Unity Piece",section:"Examples",description:"",content:`

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

ZEUGS!

`}),e.add({id:3845,href:"https://www.4players.io/examples/odin/sdk/unity/getting-started-unreal/",title:"Getting Started with Unreal",section:"Examples",description:"",content:`

HUHU

`}),e.add({id:3846,href:"https://www.4players.io/examples/fleet/global-flags/",title:"Global CLI Flags",section:"Examples",description:"A list of global flags that can be used with the ODIN CLI.",content:`

The following flags can be used with any ODIN CLI command:

--api-key=<string>
The API key to use for authentication. If omitted, the CLI will use the api-key stored in the configuration file on your system. Use odin login to store the API key for subsequent commands.
--app-id=<string>
The ID of the app to use for the command. If omitted, the CLI will use the currently selected app. Use odin apps select to select an app interactively.
--format=<string>
The output format to use for the command. Supported formats are json, value, flattened and table. If omitted, the CLI will use the default format specified in the configuration file. Learn more about output formatting.
--force
Forces the command to execute without prompting for confirmation. Use with caution.
--quiet
Suppresses all informational output except for errors. Useful for scripting and automation.

`}),e.add({id:3847,href:"https://www.4players.io/partials/odin-introduction/how-it-works/",title:"How it works",section:"Partials",description:"",content:`

graph BT
  subgraph ODIN Server
    OR2[Odin Room]
    OR[Odin Room]    
  end
  subgraph Gameserver
    GS[Game Server]
  end
  subgraph Game
    ClientA[Player A] --> OR[ODIN Room]
    ClientB[Player B] --> OR[ODIN Room] 
    ClientB[Player B] --> GS[Game Server]   
    ClientC[Player C] --> GS[Game Server]
    ClientC[Player C] --> OR[ODIN Room] 
    ClientD[Player D] --> GS[Game Server]
  end
  subgraph Lobby
    ClientE[Players E] --> OR2[ODIN Room]
    ClientF[Players F] --> OR2[ODIN Room]
  end

The possibilities are endless, and you don’t need to be an audio or server expert! We have compiled a couple of use-cases if you are still unsure if ODIN fits for needs.

`}),e.add({id:3848,href:"https://www.4players.io/examples/odin/sdk/unity/install-sdk/",title:"Install Unity SDK",section:"Examples",description:"Install Unity Example",content:`

⚠️

ODIN Voice supports Unity 2019.4 or any later version. The latest version is always available in our GitHub repository or in the Unity Asset Store.

There are numerous ways to install ODIN into your project. We recommend using Package Manager.

Install via Asset Store

Install via Unity Package

Package Manager

To open the Package Manager, navigate to Window and then click Package Manager in your Unity Editor menu bar.

Using our Git Repository

Click the + button in the upper left and select Add package from git URL. Next, enter this URL and hit enter to import the package:

Explore the docs | Download SDK

Using a Tarball Archive

Click the + button in the upper left and select Add package from tarball. Next, select the odin.tgz archive you’ve downloaded from the GitHub releases page to import the package.

`}),e.add({id:3849,href:"https://www.4players.io/examples/odin/sdk/unity/classes/odinhandler/joinroom/",title:"JoinRoom",section:"Examples",description:"OnMediaAdded Example",content:`

ODIN does not require any bookkeeping from your side. ODIN automatically creates a room when a user joins it (by name) and deletes the room once the last user has left the room.

Use the setup callback to adjust room settings before data is sent to ODIN and the room is created on the ODIN servers.

public class Radio: MonoBehaviour
{
    private string _currentRoom;
    public int currentChannel = 1;
    
    void Start()
    {
        UpdateRadioConnection();
    }
    
    public void ChangeChannel(newChannel) 
    {
        currentChannel = newChannel;
        UpdateRadioConnection();
    }
    
    void UpdateRadioConnection()
    {
        // Leave the current radio room
        if (_currentRoom) {
            OdinHandler.Instance.LeaveRoom(_currentRoom);
        }
        
        _currentRoom = "Radio_" + currentChannel.ToString();
        OdinHandler.Instance.JoinRoom(_currentRoom, null, room => {
            // Activate Voice Activity Detection 
            room.Config.ApmConfig.VadEnable = true;
        });
    }
}

`}),e.add({id:3850,href:"https://www.4players.io/partials/kicked-event-summary/unity/",title:"Kicked Event Summary",section:"Partials",description:"",content:`

Local	Remote	Description
OnRoomLeft	OnPeerLeft	Triggered if user has been kicked from a room

`}),e.add({id:3851,href:"https://www.4players.io/odin/hosting/cloud/",title:"Managed Cloud Hosting",section:"ODIN Documentation",description:"Experience seamless, global managed cloud hosting for your ODIN project with our worldwide server network. Benefit from the latest technology, high-speed networking, powerful hardware, and exceptional support from our experienced team. Register your access key and choose from our diverse gateway locations for optimal performance.",content:`

When using ODIN manage cloud hosting, you can leverage our global server network. With over 20 years of experience in the industry, our team of experts is ready to handle all the technical details, allowing you to focus on your business.

ODIN cloud servers are available in different locations all over the world, ensuring that you have the resources you need to serve your customers, no matter where they are located. With our managed cloud hosting, you can take advantage of the latest technology, including high-speed networking and powerful hardware, all backed by our top-notch support team.

Register your Access Key

Info

Please note that you need to have an active ODIN subscription to use our managed cloud hosting and the following features. You can purchase a subscription on our website.

When working with a hosted ODIN project, you need to register your access key to be able to use the service with more than 25 users. To do this, navigate to our customer control panel and select your project.

Open Control Panel

Manage Access Keys of an On-Premise Project

Next, click the Add access key button to either generate a new access key, or register an existing key you previously created using our command-line utility.

Available Gateways

Currently, we provide ODIN Gateways in the following regions for you to choose from:

Europe: https://gateway.odin.4players.io
US Central: https://us-central.gateway.odin.4players.io
US East: https://us-east.gateway.odin.4players.io
US West: https://us-west.gateway.odin.4players.io
South America: https://southamerica.gateway.odin.4players.io
Asia North East: https://asia-northeast.gateway.odin.4players.io
Oceania: https://oceania.gateway.odin.4players.io

If you need ODIN servers in additional locations, please contact us.

Firewall settings

ODIN uses a proprietary protocol built on QUIC/HTTP3. As this is latest technology, not all Office IT administrators have made the necessary adjustments to their firewalls to allow this traffic. If you are experiencing connection issues please ensure that your firewall allows traffic on these ports:

Gateway

gateway.odin.4players.io *.gateway.odin.4players.io

Port	Protocol	Description
443	TCP	HTTPS for client authorization (JSON RPC)

Voice/Data Server

*.server.4netplayers.com

Port	Protocol	Description
4433	UDP	HTTP/3 (QUIC) connections for native ODIN clients
4433	TCP	Secure WebSocket connections for web-based ODIN clients
8844	UDP	WebRTC data channel for web-based ODIN clients

`}),e.add({id:3854,href:"https://www.4players.io/odin/",title:"ODIN Documentation",section:"ODIN Documentation",description:"A cross-platform SDK to integrate real-time chat into games, apps and websites",content:`

4Players ODIN

ODIN is a cross-platform software development kit (SDK) that enables developers to integrate real-time chat technology into multiplayer games, apps and websites.

Did you just purchase ODIN and arrived here? Please generate an Access Key, if you not already have done so.

Easy integration

ODIN can be easily integrated in all your apps, websites, games and experiences with a couple lines of code. As 4Players handels servers and maintenance for you, you’ll have a production ready voice-chat and data synchronization layer implemented in your app in no-time.

These examples give you an idea how easy it is to implement ODIN in various programming languages. Please note that these are simplified examples, in real-world implementations you’ll have a couple of lines more for error handling.

Our ODIN SDK is deeply integrated into Unity and features automatic 3D spatial audio. Use the tools you know like AudioSource and AudioListener or the built-in Unity AudioMixer for your voice chat integration.

Manage all aspects of our Voice SDK within Unity and integrate it in a couple of hours into your game or XR experience.

Get Started for Free

Watch video tutorial | Explore the docs | Download SDK

Our ODIN SDK is deeply integrated into Unreal Engine 4 (UE4) and Unreal Engine 5 (UE5) and features Blueprint support and automatic 3D spatial audio. Our Voice SDK leverages Unreal Engines audio processing so that you can use the tools you know and love!

Manage all aspects of our Voice SDK within the Unreal Engine Editor and integrate it in a couple of hours into your game or XR experience.

Get Started for Free

Watch video tutorial | Explore the docs | Download SDK

Add ODIN to your C or C++ projects with our simple to use ODIN Core SDK. Our Core SDK is the foundation of all other SDKs and features an easy-to-use interface.

// Generate access token - should be done on a server
char room_token[512];
OdinTokenGenerator* generator = odin_token_generator_create("__YOUR_ACCESS_KEY__");
odin_token_generator_create_token(generator, "My Room", "John Doe", room_token, sizeof(room_token));
odin_token_generator_destroy(generator);

// Setup event handler and join a room.
OdinRoomHandle room = odin_room_create();
odin_room_set_event_callback(room, handle_odin_event, NULL);
odin_room_join(room, gateway_url, room_token);

Integrating our Voice SDK in any website with vanilla JavaScript is seamless, effortless, and easy. Add our script and join a room, that’s it.

<html>
    <head>
        <script type="text/javascript" src="https://4npcdn.com/2355/odin/javascript/latest/odin.min.js"></script>
        <script type="text/javascript">
            var connectOdin = async function(room, user) {
                const token = await getToken(room, user);
                const odinRoom = await ODIN.OdinClient.initRoom(token);
                await odinRoom.join();
                return odinRoom;
            }
            connectOdin("My Room", "John Doe").then(odinRoom => {
               console.log("Connected to room", odinRoom);
            });
        </script>
    </head>
</html>

Explore the docs | Download SDK

Adding our Voice SDK to any modern JavaScript framework like Angular, Svelve, Vue, React is super easy. Just add our npm package @4players/odin to your package.json and connect a room. That’s it.

import { OdinClient } from '@4players/odin';
import { TokenGenerator } from "@4players/odin-tokens";

const generator = new TokenGenerator(apiKey);
const token = generator.createToken("My Room", "John Doe");
const odinRoom = await OdinClient.initRoom(token);
await odinRoom.join();

Explore the docs | Download SDK

Why 4Players?

4Players is hosting game and voice servers globally for decades. We know what developers need. We know what gamers want. We know how essential reliability, awesome voice quality, low CPU usage and zero FPS hit, noise suppression and low latency are for a great voice chat experience, especially in immersive real-time applications like games.

VoIP veterans, server admins, gamers and mod makers came together to create the essential in-game voice chat solution for Unity and Unreal Engine built on latest software technologies like QUIC and HTTP3. You don’t have to worry about maintenance, server hosting or day-to-day operations. You don’t have to learn anything new. You just leverage your Unity skills and focus on delivering the best game possible.

With support for spatial 3D audio support as well as massive scalability, zero configuration or bookkeeping it has never been easier to utilize best-in-class voice chat for your games, video conferencing and XR applications.

In addition to that, we also provide SDKs for various other platforms including the web with TypeScript and Vanilla JavaScript support and even console clients for automatic data processing. This ODIN, all your real-time data synchronization are solved and implemented in no time, being it pure data and/or voice.

Give it a try

We have created a couple of simple multiplayer experiences that allow you to play around with ODIN together with your friends and colleagues. Download the samples for Windows, Mac or Linux and experience cross-platform 3D voice chat in a dynamic environment.

Open Source Sample

Download and test our PUN based multiplayer sample built with Unity complete with source and documentation. The sample also features many scripts for audio effects like damping and general bookkeeping stuff.

Download Sample

Multiplatform Showcase

Talk to other players with 3D positional voice and a walkie-talkie in multiple channels. We also feature a web-based commander that you can use to interact with players directly from your browser.

Play now

FPS Shooter

A simple but fun FPS shooter on desert style maps. ODIN 3D positional voice is integrated so that you can talk to other players with voice or radio broadcast in a real game. Have fun!

Play Now

SwiftUI Sample

A simple but fully functional SwiftUI sample that leverages OdinKit to build an iOS app that allows you to chat with friends in no time.

Download Now

First Steps

Begin with our Introduction to learn more about ODIN, how it works, which benefits and key features we provide.

Game Engine Integration

If you are more into just experimenting, then choose your game engine and get started quickly with our quick and easy onboarding guides. You’ll have a running example to experiment with in less than 20 minutes without any registration!

Unity

Use our deep Unity integration to add the most immersive in-game voice chat to your product with minimal development overhead.

Unreal Engine

Our upcoming Unreal Engine plugin will feature full support for all available platforms and come with Blueprint and C++ support.