@4players/odin-nodejs 0.8.0 → 0.9.1

package/cppsrc/odinclient.cpp

@@ -46,6 +46,7 @@ OdinClient::OdinClient(const Napi::CallbackInfo& info) : Napi::ObjectWrap<OdinCl
 
     if (info.Length() < 1 || !info[0].IsString()) {
         Napi::TypeError::New(env, "Access Key required as first parameter").ThrowAsJavaScriptException();
+        return;
     }
 
     _accessKey = info[0].ToString().Utf8Value();
@@ -57,6 +58,7 @@ OdinClient::OdinClient(const Napi::CallbackInfo& info) : Napi::ObjectWrap<OdinCl
             _sampleRate = info[1].ToNumber();
         } else {
             Napi::TypeError::New(env, "Sample rate must be a number").ThrowAsJavaScriptException();
+            return;
         }
     }
 
@@ -65,6 +67,7 @@ OdinClient::OdinClient(const Napi::CallbackInfo& info) : Napi::ObjectWrap<OdinCl
             _numChannels = info[2].ToNumber();
         } else {
             Napi::TypeError::New(env, "Channels must be a number").ThrowAsJavaScriptException();
+            return;
         }
     }
 
@@ -98,6 +101,7 @@ Napi::Value OdinClient::GenerateAccessToken(const Napi::CallbackInfo &info)
 
     if (info.Length() != 2 || !info[0].IsString() || !info[1].IsString()) {
         Napi::TypeError::New(env, "Room and User Id expected").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     std::string roomId = info[0].ToString().Utf8Value();
@@ -107,6 +111,7 @@ Napi::Value OdinClient::GenerateAccessToken(const Napi::CallbackInfo &info)
     if (!generator)
     {
         Napi::TypeError::New(env, "Failed to initialize token generator, invalid access key").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     /*
@@ -117,6 +122,7 @@ Napi::Value OdinClient::GenerateAccessToken(const Napi::CallbackInfo &info)
     if (odin_is_error(error))
     {
         Napi::TypeError::New(env, "Creating access token failed").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     /*
@@ -137,6 +143,7 @@ Napi::Value OdinClient::CreateRoom(const Napi::CallbackInfo &info) {
 
     if (info.Length() != 2 || !info[0].IsString() || !info[1].IsString()) {
         Napi::TypeError::New(env, "Room and User Id expected").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     std::string roomId = info[0].ToString().Utf8Value();

package/cppsrc/odinmedia.cpp

@@ -25,6 +25,7 @@ Napi::Value OdinMedia::MediaId(const Napi::CallbackInfo &info) {
     OdinReturnCode error = odin_media_stream_media_id(_mediaStreamHandle, &out_id);
     if (odin_is_error(error)) {
         Napi::TypeError::New(env, "Failed to get media id").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     return Napi::Number::New(env, out_id);
@@ -41,10 +42,12 @@ OdinMedia::OdinMedia(const Napi::CallbackInfo &info) : Napi::ObjectWrap<OdinMedi
     // Checking for room instance, sample rate (float) and channels (int)
     if (info.Length() < 3 || !info[0].IsObject() || !info[1].IsNumber() || !info[2].IsNumber()) {
         Napi::TypeError::New(env, "Provide an OdinRoom instance, sample rate and number of channels as number").ThrowAsJavaScriptException();
+        return;
     }
 
     if (info.Length() == 4 && !info[3].IsObject()) {
         Napi::TypeError::New(env, "Options need to be provided as an object").ThrowAsJavaScriptException();
+        return;
     }
 
     _room = Napi::ObjectWrap<OdinRoom>::Unwrap(info[0].As<Napi::Object>());
@@ -227,6 +230,7 @@ void OdinMedia::SendData(const Napi::CallbackInfo &info) {
 
     if (info.Length() < 1 || !info[0].IsTypedArray()) {
         Napi::TypeError::New(env, "TypedArray required as first parameter").ThrowAsJavaScriptException();
+        return;
     }
 
     Napi::Float32Array array = info[0].As<Napi::Float32Array>();

package/cppsrc/odinroom.cpp

@@ -114,6 +114,7 @@ Napi::Value OdinRoom::RoomId(const Napi::CallbackInfo &info) {
     if (odin_is_error(error))
     {
         Napi::TypeError::New(env, "Failed to get room id").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     return Napi::String::New(env, out_id);
@@ -303,6 +304,7 @@ OdinRoom::OdinRoom(const Napi::CallbackInfo& info) :Napi::ObjectWrap<OdinRoom>(i
 
     if (info.Length() != 1 || !info[0].IsString()) {
         Napi::TypeError::New(env, "Provide a token to create a room").ThrowAsJavaScriptException();
+        return;
     }
 
     _token = info[0].ToString().Utf8Value();
@@ -331,6 +333,8 @@ Napi::Object OdinRoom::Init(Napi::Env env, Napi::Object exports) {
     Napi::Function func = DefineClass(env, "OdinRoom", {
         InstanceMethod<&OdinRoom::Join>("join", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::UpdatePeerUserData>("updateOwnUserData", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+        InstanceMethod<&OdinRoom::UpdatePosition>("updatePosition", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+        InstanceMethod<&OdinRoom::SetPositionScale>("setPositionScale", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::SendMessage>("sendMessage", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::SetEventListener>("setEventListener", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
         InstanceMethod<&OdinRoom::AddEventListener>("addEventListener", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
@@ -365,6 +369,52 @@ Napi::Object OdinRoom::Init(Napi::Env env, Napi::Object exports) {
     return exports;
 }
 
+/**
+ * Updates the position of this room. Requires x, y and z coordinates as parameters.
+ * @param info Napi::CallbackInfo
+ */
+void OdinRoom::UpdatePosition(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    if (info.Length() != 3 || !info[0].IsNumber() || !info[1].IsNumber() || !info[2].IsNumber()) {
+        Napi::TypeError::New(env, "Provide x, y and z coordinates as numbers").ThrowAsJavaScriptException();
+        return;
+    }
+
+    float x = info[0].ToNumber();
+    float y = info[1].ToNumber();
+    float z = info[2].ToNumber();
+
+    OdinReturnCode error = odin_room_update_position(_roomHandle, x, y, z);
+    if (odin_is_error(error))
+    {
+        OdinUtilities::ThrowNapiException(env, error, "Failed to update position");
+    }
+}
+
+/**
+ * Sets the position scale for this room. Requires a scale as a parameter.
+ * @param info Napi::CallbackInfo
+ */
+void OdinRoom::SetPositionScale(const Napi::CallbackInfo &info)
+{
+    Napi::Env env = info.Env();
+
+    if (info.Length() != 1 || !info[0].IsNumber()) {
+        Napi::TypeError::New(env, "Provide scale as number").ThrowAsJavaScriptException();
+        return;
+    }
+
+    float scale = info[0].ToNumber();
+
+    OdinReturnCode error = odin_room_set_position_scale(_roomHandle, scale);
+    if (odin_is_error(error))
+    {
+        OdinUtilities::ThrowNapiException(env, error, "Failed to set position scale");
+    }
+}
+
 /**
  * Joins the Odin room. Requires a gateway URL as a parameter and optionally initial peer data.
  * @param info Napi::CallbackInfo
@@ -374,6 +424,7 @@ void OdinRoom::Join(const Napi::CallbackInfo &info) {
 
     if (info.Length() < 1) {
         Napi::TypeError::New(env, "Gateway required as first parameter").ThrowAsJavaScriptException();
+        return;
     }
 
     std::string url = info[0].ToString().Utf8Value();
@@ -391,6 +442,7 @@ void OdinRoom::Join(const Napi::CallbackInfo &info) {
     if (odin_is_error(error))
     {
         OdinUtilities::ThrowNapiException(env, error, "Failed to join room");
+        return;
     }
 
     _joined = true;
@@ -439,6 +491,7 @@ Napi::Value OdinRoom::CreateNewItem(const Napi::CallbackInfo& info) {
 
     if (info.Length() < 1) {
         Napi::TypeError::New(env, "Token required as first parameter").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     Napi::String token = info[0].ToString();
@@ -470,6 +523,7 @@ void OdinRoom::UpdatePeerUserData(const Napi::CallbackInfo &info) {
 
     if (info.Length() != 1 || !info[0].IsTypedArray()) {
         Napi::TypeError::New(env, "Data as byte array expected").ThrowAsJavaScriptException();
+        return;
     }
 
     Napi::Uint8Array data = info[0].As<Napi::Uint8Array>();
@@ -494,6 +548,7 @@ void OdinRoom::SendMessage(const Napi::CallbackInfo &info) {
 
     if (info.Length() < 1 || !info[0].IsTypedArray()) {
         Napi::TypeError::New(env, "Data as byte array expected").ThrowAsJavaScriptException();
+        return;
     }
 
     Napi::Uint8Array data = info[0].As<Napi::Uint8Array>();
@@ -535,6 +590,7 @@ void OdinRoom::SetEventListener(const Napi::CallbackInfo &info) {
 
     if (info.Length() != 1 || !info[0].IsFunction()) {
         Napi::TypeError::New(env, "Callback function expected").ThrowAsJavaScriptException();
+        return;
     }
 
     Napi::Function napiFunction = info[0].As<Napi::Function>();
@@ -552,6 +608,7 @@ void OdinRoom::AddEventListener(const Napi::CallbackInfo &info) {
 
     if (info.Length() != 2 || !info[0].IsString() || !info[1].IsFunction()) {
         Napi::TypeError::New(env, "Event Name and Callback function expected").ThrowAsJavaScriptException();
+        return;
     }
 
     std::string eventName = info[0].As<Napi::String>().Utf8Value();
@@ -586,6 +643,7 @@ void OdinRoom::RemoveEventListener(const Napi::CallbackInfo &info) {
 
     if (info.Length() != 1 || !info[0].IsString()) {
         Napi::TypeError::New(env, "Event Name expected").ThrowAsJavaScriptException();
+        return;
     }
 
     std::string eventName = info[0].As<Napi::String>().Utf8Value();
@@ -688,10 +746,12 @@ Napi::Value OdinRoom::CreateAudioStream(const Napi::CallbackInfo &info)
     // Checking for input of sample rate (int) and number of channels (int)
     if (info.Length() != 2 || !info[0].IsNumber() || !info[1].IsNumber()) {
         Napi::TypeError::New(env, "Sample rate and number of channels expected").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     if (info.Length() == 3 && !info[2].IsObject()) {
         Napi::TypeError::New(env, "Options need to be an object").ThrowAsJavaScriptException();
+        return env.Undefined();
     }
 
     if (info.Length() == 2) {

package/cppsrc/odinroom.h

@@ -56,6 +56,8 @@ private:
     EventData* PrepareEventData(OdinEvent* event);
     static uint16_t GetMediaIdFromHandle(OdinMediaStreamHandle handle);
     void HandleAudioData();
+    void UpdatePosition(const Napi::CallbackInfo &info);
+    void SetPositionScale(const Napi::CallbackInfo &info);
 
     Napi::Value CreateAudioStream(const Napi::CallbackInfo &info);
 };

package/odin.room.d.ts

@@ -445,6 +445,34 @@ export declare class OdinRoom {
      */
     updateOwnUserData(userData: Uint8Array): 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.
+     *
+     * @param x - The new x position of the peer.
+     * @param y - The new y position of the peer.
+     * @param z - The new z position of the peer.
+     */
+    updatePosition(x: number, y: number, z: 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.
+     * @param scale - The new scaling factor to use.
+     */
+    setPositionScale(scale: number);
+
     /**
      * Closes the room and disconnects from the server.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-nodejs",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "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",