Developer Documentation

INTRODUCING ODIN SDK

Real-time data for your apps, games and websites

Generate and process data in real-time - combined with voice.

Real-time data made simple

Send and process data in real-time using our platform and create interactive experiences in apps, games and on websites.

import { OdinClient } from '@4players/odin';
import { TokenGenerator } from "@4players/odin-tokens";

// Prepare the token to connect
const generator = new TokenGenerator(apiKey);
const token = generator.createToken("My Room", "John Doe");
const odinRoom = await OdinClient.initRoom(token);

// Handle events for new peers joining the room
odinRoom.addEventListener('MessageReceived', (event) => {
    console.log(`Received message ${event.payload.messsage}`);
});

// Connect the room
await odinRoom.join();

// Send a message to other clients
const data = {
    sender: "John Doe",
    senderId: "abcdef123456",
    message: "Hello world!"
};
const encoder = new TextEncoder();
await odinRoom.sendMessage(encoder.encode(JSON.stringify(data)));

Use the SendMessage function available in all our SDKs to send arbitrary data to all or selected clients connected to the same room.

This function is often used in messaging. Our SDK is very flexible and empowers you to design your very own protocol - easily and fitting into your existing data structures without converting back and forth all the time.

Within our ecosystem, messages are just an array of bytes and you can convert all your data directly to it.

Keep users or shared data automatically in sync

With all our SDKs, every peer connected to our servers with the JoinRoom function has a userData property that can be used to store arbitrary data. This can be anything, from a binary stream, to JSON, whatever makes sense to you.

Our servers make sure, that the data is kept in sync of all clients. Whenever the data changes, all clients get notified automatically. A dating app, storing the current GPS location of a user and syncing it in real-time with their mate so they can meet easily on crowded places.

The SDKs automatically optimize bandwidth usage by only sending and processing changed bytes. Just update the users data as often as you like and use the update function to update them on the servers. The callback PeerUserDataChanged gets the whole user data. There is no requirement on your side to process that data.

import { OdinClient } from '@4players/odin';
import { TokenGenerator } from "@4players/odin-tokens";

// Prepare the token to connect
const generator = new TokenGenerator(apiKey);
const token = generator.createToken("My Room", "John Doe");
const odinRoom = await OdinClient.initRoom(token);

// Handle events for new peers joining the room
odinRoom.addEventListener('PeerUserDataChanged', (event) => {
    console.log(`Peer data updated ${event.payload.peer.data}`);
});

// Connect the room
await odinRoom.join();

// Send a message to other clients
const data = {
    location: {
        longitude: CurrentLocation.longitude,
        latitude: CurrentLocation.latitude
    },
    name: User.name
};
const encoder = new TextEncoder();
odinRoom.ownPeer.data = encoder.encode(JSON.stringify(data));
await odinRoom.ownPeer.update();

Next-Gen solutions for your business

Our technology has been battle-tested in gaming - the toughest environment imaginable for real-time applications and services. Leverage our know-how and expertise today! Learn more how our products and services empower your business.

Pricing

Leverage the global reach of the 4Players Cloud, spanning over 14 locations worldwide. Our intelligent SDK optimizes user experience by auto-selecting the prime location for connectivity.

Trial
Free
Ideal for evaluation and development

  • Ideal for evaluation and development
  • Up to 25 PCUs
  • Unity and Unreal Engine Plugins
  • Web and mobile SDKs
  • Documentation, Samples and AI Bot
  • No registration required

    What is Peak Concurrent User (PCU) ?

    Concurrent Users (CU) denotes the total number of users actively connected to the ODIN servers at any given moment, while Peak Concurrent Users (PCU) represents the zenith of this count over a monthly duration. With ODIN’s advanced dashboard, enterprises can monitor real-time user engagement and even set constraints on the peak value, ensuring consistent budget management and optimal server resource utilization.

    Requiring a Custom Pricing Structure?

    Should our standard pricing model not align with your enterprise’s unique requirements, we invite you to reach out. Our team is committed to crafting tailored proposals that seamlessly match your needs.

    Download the ODIN server and gateway tools to seamlessly deploy ODIN servers at your preferred locations.

    Custom License
    Get a quote
    Ideal for encapsulated environments like military, health and other applications that require to follow highest security standards

    • Perfect for high-security sectors: military, healthcare
    • Internet connection optional
    • 12 months software updates included
    • Windows, Linux, macOS support
    • On-premise, AWS, Google Cloud, Azure, and more
    • Horizontally scalable
    • Community Support via Discord
    • Documentation, Samples and AI Bot

      Requiring a Custom Pricing Structure?

      Should our standard pricing model not align with your enterprise’s unique requirements, we invite you to reach out. Our team is committed to crafting tailored proposals that seamlessly match your needs.

      Next-generation technology

      Most existing voice-chat solutions rely on WebRTC, which has been designed primarily for P2P connections between browsers and is optimized for continuous media streaming… but voice is discontinuous by nature.

      ODIN is developed from scratch based on HTTP/3 and QUIC with nearly zero dependencies allowing us to deliver excellent voice quality seamlessly embedded into your game engine.

      Hosted by us or host yourself

      We love gaming! We are gamers! We know that real-time communication is essential for a fun and immersive gaming experience. This is why our new and innovative voice chat adds another layer of realism to any game or any other virtual interaction, elevating regular voice from chatter to a true communication feature.

      With our Voice SDK, we provide a complete out-of-the-box solution that has been designed and built from the ground up for gamers, developers and publishers: flexible, feature-rich and cross-platform.

      Reduce development time by leveraging our best-in-class technology to deliver seamless in-app communication.

      4Players has more than 20 years of experience hosting game and voice servers for gamers. You can trust in us that we provide the highest quality of service for you and your players.

      If you want to be in charge, no worries, we got you covered. Our servers can be easily hosted everywhere. Contact us for more information about self-hosting.