@4players/odin-nodejs 0.9.1 → 0.10.0

package/cppsrc/odinclient.cpp

@@ -12,7 +12,8 @@ Napi::Object OdinClient::Init(Napi::Env env, Napi::Object exports) {
     // This method is used to hook the accessor and method callbacks
     Napi::Function func = DefineClass(env, "OdinClient", {
             InstanceMethod<&OdinClient::GenerateAccessToken>("generateAccessToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
-            InstanceMethod<&OdinClient::CreateRoom>("createRoom", static_cast<napi_property_attributes>(napi_writable | napi_configurable))
+            InstanceMethod<&OdinClient::CreateRoom>("createRoom", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+            InstanceMethod<&OdinClient::CreateRoomWithAccessToken>("createRoomWithAccessToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable))
     });
 
     Napi::FunctionReference* constructor = new Napi::FunctionReference();
@@ -44,27 +45,21 @@ OdinClient::OdinClient(const Napi::CallbackInfo& info) : Napi::ObjectWrap<OdinCl
     Napi::Env env = info.Env();
     Napi::HandleScope scope(env);
 
-    if (info.Length() < 1 || !info[0].IsString()) {
-        Napi::TypeError::New(env, "Access Key required as first parameter").ThrowAsJavaScriptException();
-        return;
-    }
-
-    _accessKey = info[0].ToString().Utf8Value();
     _sampleRate = 48000;
     _numChannels = 1;
 
-    if (info.Length() >= 2) {
-        if (info[1].IsNumber()) {
-            _sampleRate = info[1].ToNumber();
+    if (info.Length() >= 1) {
+        if (info[0].IsNumber()) {
+            _sampleRate = info[0].ToNumber();
         } else {
             Napi::TypeError::New(env, "Sample rate must be a number").ThrowAsJavaScriptException();
             return;
         }
     }
 
-    if (info.Length() >= 3) {
-        if (info[2].IsNumber()) {
-            _numChannels = info[2].ToNumber();
+    if (info.Length() >= 2) {
+        if (info[1].IsNumber()) {
+            _numChannels = info[1].ToNumber();
         } else {
             Napi::TypeError::New(env, "Channels must be a number").ThrowAsJavaScriptException();
             return;
@@ -87,7 +82,6 @@ OdinClient::OdinClient(const Napi::CallbackInfo& info) : Napi::ObjectWrap<OdinCl
  * OdinClient destructor
  */
 void OdinClient::Finalize(Napi::Env env) {
-
 }
 
 /**
@@ -99,15 +93,16 @@ Napi::Value OdinClient::GenerateAccessToken(const Napi::CallbackInfo &info)
 {
     Napi::Env env = info.Env();
 
-    if (info.Length() != 2 || !info[0].IsString() || !info[1].IsString()) {
-        Napi::TypeError::New(env, "Room and User Id expected").ThrowAsJavaScriptException();
+    if (info.Length() != 3 || !info[0].IsString() || !info[1].IsString() || !info[2].IsString()) {
+        Napi::TypeError::New(env, "Access-Key, Room and User Id expected").ThrowAsJavaScriptException();
         return env.Undefined();
     }
 
-    std::string roomId = info[0].ToString().Utf8Value();
-    std::string userId = info[1].ToString().Utf8Value();
+    std::string accessKey = info[0].ToString().Utf8Value();
+    std::string roomId = info[1].ToString().Utf8Value();
+    std::string userId = info[2].ToString().Utf8Value();
 
-    OdinTokenGenerator *generator = odin_token_generator_create(_accessKey.c_str());
+    OdinTokenGenerator *generator = odin_token_generator_create(accessKey.c_str());
     if (!generator)
     {
         Napi::TypeError::New(env, "Failed to initialize token generator, invalid access key").ThrowAsJavaScriptException();
@@ -141,15 +136,16 @@ Napi::Value OdinClient::GenerateAccessToken(const Napi::CallbackInfo &info)
 Napi::Value OdinClient::CreateRoom(const Napi::CallbackInfo &info) {
     Napi::Env env = info.Env();
 
-    if (info.Length() != 2 || !info[0].IsString() || !info[1].IsString()) {
-        Napi::TypeError::New(env, "Room and User Id expected").ThrowAsJavaScriptException();
+    if (info.Length() != 3 || !info[0].IsString() || !info[1].IsString() || !info[2].IsString()) {
+        Napi::TypeError::New(env, "Access-Key, Room and User Id expected").ThrowAsJavaScriptException();
         return env.Undefined();
     }
 
-    std::string roomId = info[0].ToString().Utf8Value();
-    std::string userId = info[1].ToString().Utf8Value();
+    std::string accessKey = info[0].ToString().Utf8Value();
+    std::string roomId = info[1].ToString().Utf8Value();
+    std::string userId = info[2].ToString().Utf8Value();
 
-    OdinTokenGenerator *generator = odin_token_generator_create(_accessKey.c_str());
+    OdinTokenGenerator *generator = odin_token_generator_create(accessKey.c_str());
     if (!generator)
     {
         Napi::TypeError::New(env, "Failed to initialize token generator, invalid access key").ThrowAsJavaScriptException();
@@ -176,3 +172,23 @@ Napi::Value OdinClient::CreateRoom(const Napi::CallbackInfo &info) {
 
     return OdinRoom::NewInstance(Napi::String::New(env, room_token));
 }
+
+
+/**
+ * Create a new room with a given access token
+ * @param info
+ * @return
+ */
+Napi::Value OdinClient::CreateRoomWithAccessToken(const Napi::CallbackInfo &info) {
+    Napi::Env env = info.Env();
+
+    // Check for existence of access token
+    if (info.Length() < 1 || !info[0].IsString()) {
+        Napi::TypeError::New(env, "Access token expected").ThrowAsJavaScriptException();
+        return env.Undefined();
+    }
+
+    std::string token = info[0].ToString().Utf8Value();
+
+    return OdinRoom::NewInstance(Napi::String::New(env, token));
+}

package/cppsrc/odinclient.h

@@ -9,9 +9,8 @@ class OdinClient : public Napi::ObjectWrap<OdinClient> {
  private:
     Napi::Value GenerateAccessToken(const Napi::CallbackInfo& info);
     Napi::Value CreateRoom(const Napi::CallbackInfo& info);
+    Napi::Value CreateRoomWithAccessToken(const Napi::CallbackInfo& info);
 
     float _sampleRate;
     uint32_t _numChannels;
-
-    std::string _accessKey;
 };

package/odin.client.d.ts

@@ -6,17 +6,33 @@ import {OdinRoom} from "./odin.room";
  */
 export declare class OdinClient {
     /**
-     * Creates a new instance of a client with an access key.
-     * @param accessKey - The access key to use for this client. You can get one from https://developers.4players.io
-     * @param sampleRate - The sample rate of the audio stream (between 8000 and 48000)
-     * @param channelCount - The number of channels of the audio stream (1 or 2)
+     * Creates a new instance of a client. Use this to create rooms.
+     * @param sampleRate - The sample rate of the audio stream (between 8000 and 48000) - default is 48000
+     * @param channelCount - The number of channels of the audio stream (1 or 2) - default is 1
      */
-    constructor(accessKey: string, sampleRate?: number, channelCount?: number);
+    constructor(sampleRate?: number, channelCount?: number);
+
+    /**
+     * Generates an access token for the given access key, room and user ID. This token can be used to join the room.
+     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
+     * @param roomId - The ID of the room to generate the token for.
+     * @param userId - The ID of the user to generate the token for.
+     */
+    generateAccessToken(accessKey: string, roomId: string, userId: string): string;
 
     /**
      * Creates a new local room instance with the given ID and user ID. Use join to connect to that room.
+     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
      * @param roomId - The ID of the room to create.
      * @param userId - The ID of the user to create the room for.
      */
-    createRoom(roomId: string, userId: string): OdinRoom;
+    createRoom(accessKey: string, roomId: string, userId: 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
+     * `generateAccessToken`.
+     * @param accessToken - The access token to use to join the room.
+    */
+    createRoomWithAccessToken(accessToken: string): OdinRoom;
 }

package/odin.media.d.ts

@@ -19,6 +19,20 @@ export declare class OdinMedia {
      */
     close(): 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.
+     */
+    pause(): 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.
+     */
+    resume(): 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

package/odin.room.d.ts

@@ -402,16 +402,17 @@ export declare interface OdinAPMSettings {
 export declare class 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.
      * @param token - The token to use for this room.
      */
     constructor(token: string);
 
     /**
      * Joins the room with the given gateway URL and optional user data.
-     * @param gatewayUrl - The gateway URL to connect to. Use gateway.odin.4players.io if you are unsure.
+     * @param gatewayUrlOrServer - The gateway URL to connect to or the URL to the ODIN Server instance. Use gateway.odin.4players.io if you are unsure.
      * @param userData - The user data to send to the room. This can be used to identify the user.
      */
-    join(gatewayUrl: string, userData?: Uint8Array): void;
+    join(gatewayOrServerUrl: string, userData?: Uint8Array): void;
 
     /**
      * Sends a message to the room.
@@ -471,7 +472,7 @@ export declare class OdinRoom {
      * Note: It's crucial to maintain consistent scaling across all client applications.
      * @param scale - The new scaling factor to use.
      */
-    setPositionScale(scale: number);
+    setPositionScale(scale: number): void;
 
     /**
      * Closes the room and disconnects from the server.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-nodejs",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "NodeJS bindings for the ODIN SDK. Use for AI enhanced human interactions, content moderation and audio processing features in a backend.",
   "main": "index.cjs",
   "types": "index.d.ts",

package/tests/sending-audio/index.js

@@ -1,4 +1,4 @@
-const accessKey = "__YOUR_ACCESS_KEY__";
+const accessKey = "ASBKPRwUpEabybkUJMfdLD2b2J8K2mus1ekxMUK7VPEA";
 const roomName = "Lobby";
 const userName = "My Bot";
 
@@ -21,8 +21,14 @@ const userData = {
     version: "0.1"
 }
 const data = new TextEncoder().encode(JSON.stringify(userData));
-const odinClient = new OdinClient(accessKey, 48000, 2);
-const room = odinClient.createRoom(roomName, userName);
+const odinClient = new OdinClient(48000, 2);
+
+// Create a token then join the room with that token, token may also be created elsewhere
+const token = odinClient.generateAccessToken(accessKey, roomName, userName);
+const room = odinClient.createRoomWithAccessToken(token);
+
+// It's also possible to create a room with an access key, room name and username then token is created internally
+//const room = odinClient.createRoom(accessKey, roomName, userName);
 
 // Join the room
 room.join("gateway.odin.4players.io", data);
@@ -73,6 +79,9 @@ const sendMusic = async (media) => {
     audioBufferStream.write(audioBuffer);
 }
 
+room.setPositionScale(25);
+room.updatePosition(0, 0, 0);
+
 // 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);