vivox-sdk-node 1.0.0 → 1.1.1

package/README.md

@@ -1,62 +1,92 @@
-# Vivox SDK Node.js Addon
+# Vivox SDK Node.js Wrapper
 
-Bu proje, Vivox SDK'sını Node.js projelerinde kullanabilmek için hazırlanmış bir C++ Addon'dur. Tüm Windows mimarilerini (x64, Win32, arm64) destekleyecek şekilde yapılandırılmıştır.
+A high-performance, fully type-safe Node.js C++ addon for the Vivox SDK. This wrapper provides an asynchronous, EventEmitter-based API to integrate Vivox voice and text chat into your Node.js applications.
 
-## Özellikler
-- **Çoklu Mimari Desteği:** `binding.gyp` dosyası x64, Win32 ve arm64 mimarileri için doğru kütüphane ve DLL eşleştirmelerini otomatik yapar.
-- **Asenkron Olay Döngüsü:** C++ tarafında çalışan bir arka plan iş parçacığı (background thread), Vivox SDK'sından gelen mesajları toplar ve Node.js tarafına `ThreadSafeFunction` kullanarak iletir.
-- **Yüksek Performans:** N-API (Node-Addon-API) kullanılarak geliştirilmiştir.
+## Features
 
-## Kurulum ve Derleme
+- **Asynchronous Event Loop:** Native C++ thread handles Vivox messages and dispatches them to Node.js via `ThreadSafeFunction`.
+- **Full TypeScript Support:** Includes comprehensive interfaces for all events, status codes, and SDK enums.
+- **Strict Error Handling:** Automatically resolves numerical status codes into official Vivox SDK error names (e.g., `VX_E_ACCESSTOKEN_ALREADY_USED`).
+- **Memory Safe:** Implements proper lifecycle management for requests and internal SDK messages to prevent leaks.
+- **Local Moderation:** Built-in methods for local muting, user volume control, and microphone muting.
+- **Audio Injection:** Support for streaming mono 16-bit PCM WAV files into channels.
+- **Positional Audio:** Simple 3D spatial audio positioning support.
 
-### Ön Gereksinimler
-- Node.js (v14 veya üzeri önerilir)
-- Python 3.x
-- Visual Studio 2017 veya üzeri (C++ Masaüstü Geliştirme iş yükü yüklü olmalıdır)
+## Project Structure
 
-### Adımlar
-1. `node-addon` dizinine gidin:
-   ```bash
-   cd node-addon
-   ```
-2. Bağımlılıkları yükleyin:
-   ```bash
-   npm install
-   ```
-3. Addon'u derleyin:
-   ```bash
-   npm run build
-   ```
+The project has been optimized to be lightweight. The core SDK binaries and headers are stored locally within the package, making it portable and easy to install.
 
-## Kullanım
+## Installation
 
-Yeni sürüm `EventEmitter` yapısını destekler:
+```bash
+npm install vivox-sdk-node
+```
+
+*Note: The native addon will automatically compile during installation if build tools (Python, Visual Studio/C++) are available.*
+
+## Connection Flow
+
+Vivox requires a specific sequence of operations. You **must** create a connector before attempting to login.
+
+1.  **Initialize:** Call `vivox.initialize()`.
+2.  **Setup Listeners:** Listen for `connectorCreated`, `loginSuccess`, and `joinSuccess`.
+3.  **Create Connector:** Call `vivox.connectorCreate(serverUrl)`.
+4.  **Login:** Inside the `connectorCreated` event, call `vivox.login()` or `vivox.loginAnonymous()`.
+5.  **Join:** Inside the `loginSuccess` event, call `vivox.joinChannel()`.
+
+## Quick Start
 
 ```javascript
-const vivox = require('./index');
+const vivox = require('vivox-sdk-node');
+const { VivoxUtils, VivoxError } = require('vivox-sdk-node');
 
-// Olayları dinle
-vivox.on('loginSuccess', (event) => {
-    console.log('Başarıyla giriş yapıldı');
-});
+vivox.initialize();
 
-vivox.on('participantAdded', (event) => {
-    console.log('Yeni katılımcı:', event.participant_uri);
+// Step 1: Wait for connector
+vivox.on('connectorCreated', (event) => {
+    if (event.status === VivoxError.VX_E_SUCCESS) {
+        // Step 2: Login
+        vivox.loginAnonymous("main_connector", accountUri, LOGIN_TOKEN);
+    }
 });
 
-vivox.on('message', (event) => {
-    console.log(`${event.participant_uri} dedi ki: ${event.message}`);
+vivox.on('loginSuccess', (event) => {
+    // Step 3: Join Channel
+    vivox.joinChannel(accountUri, channelUri, CHANNEL_TOKEN);
 });
 
-// SDK'yı başlat
-vivox.initialize();
+// Start the flow
+vivox.connectorCreate("https://your-vivox-server.com/app", "main_connector");
+```
 
-// Test verileriyle bağlan (Otomatik Connector -> Login -> Join süreci)
-vivox.connectWithTestData(require('./test_data.json'));
+## Local Moderation Examples
+
+```javascript
+// Mute yourself (other players won't hear you)
+vivox.muteLocalMic("main_connector", true);
+
+// Mute a specific participant locally (for you only)
+vivox.setParticipantMute(sessionHandle, "sip:target-user@domain", true);
+
+// Adjust volume of a specific participant
+vivox.setParticipantVolume(sessionHandle, "sip:target-user@domain", 50);
+```
+
+## Audio Injection
+
+Inject a `.wav` file (must be 16-bit PCM, Mono, matching channel sample rate):
+
+```javascript
+vivox.injectAudio(accountHandle, "path/to/audio.wav");
 ```
 
-## Gelişmiş Özellikler
-- **Cihaz Listeleme:** `vivox.getCaptureDevices()` ve `vivox.getRenderDevices()` çağrıları sonrası `captureDevices` ve `renderDevices` olayları tetiklenir.
-- **Mesaj Gönderme:** `vivox.sendMessage(sessHandle, "Mesaj içeriği")`
-- **Katılımcı Kontrolü:** `vivox.setParticipantMute(sessHandle, uri, true)` ve `vivox.setParticipantVolume(sessHandle, uri, 50)`
-- **3D Ses:** `vivox.set3DPosition(acctHandle, x, y, z, channelUri)`
+## Scripts
+
+- `npm run build`: Rebuild the native C++ addon.
+- `npm run compile`: Recompile the TypeScript wrapper.
+- `npm test`: Run the standard connection example.
+
+## License
+
+This project is licensed under the MIT License.
+Vivox SDK is a trademark of Unity Technologies.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "vivox-sdk-node",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "High-performance, type-safe Node.js wrapper for the Vivox SDK.",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
     "install": "node-gyp rebuild",
     "build": "node-gyp rebuild",
-    "test": "node example_test.js",
+    "test": "node example.js",
     "compile": "npx tsc"
   },
   "keywords": [