@4players/odin-nodejs 0.7.3 → 0.7.4

package/README.md

@@ -3,7 +3,15 @@
 Native Node JS bindings for the ODIN SDK. It is based on the [ODIN Native SDK](https://github.com/4Players/odin-sdk) and
 wraps the C++ code into a Node JS module.
 
-Please check out the typings in `index.d.ts` for more information on the API.
+Check out documentation and guides at [developers.4players.io](https://www.4players.io/odin/sdk/nodejs).
+
+## Beta!
+
+**This SDK is currently in beta. This means that the API is not final and might change in the future. It's also not ready
+for production use as there might be bugs, memory leaks or other issues.** But it's good enough for testing AI 
+integration, recording or other interesting use cases.
+
+If you have any questions or feedback, please reach out to us at our [Discord Server](https://4np.de/discord).
 
 ## ODIN Node JS compared to Web SDK
 

package/index.d.ts

@@ -2,4 +2,10 @@ export * from "./odin.client";
 export * from "./odin.room";
 export * from "./odin.media";
 
+/**
+ * Generates an access token for a room and user ID. You can use this to join a room with a custom access token.
+ * @param accessKey - The access key to use for this client. You can get one from https://developers.4players.io
+ * @param roomId - The ID of the room to create.
+ * @param userId - The ID of the user
+ */
 export declare function generateAccessToken(accessKey: string, roomId: string, userId: string): string;

package/odin.client.d.ts

@@ -7,16 +7,16 @@ import {OdinRoom} from "./odin.room";
 export declare class OdinClient {
     /**
      * Creates a new instance of a client with an access key.
-     * @param accessKey {string} The access key to use for this client. You can get one from https://developers.4players.io
-     * @param sampleRate {number} The sample rate of the audio stream (between 8000 and 48000)
-     * @param channelCount {number} The number of channels of the audio stream (1 or 2)
+     * @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)
      */
     constructor(accessKey: string, sampleRate?: number, channelCount?: number);
 
     /**
      * Creates a new local room instance with the given ID and user ID. Use join to connect to that room.
-     * @param roomId {string} The ID of the room to create.
-     * @param userId {string} The ID of the user to create the room for.
+     * @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;
 }

package/odin.media.d.ts

@@ -7,9 +7,9 @@ import {OdinRoom} from "./odin.room";
 export declare class OdinMedia {
     /**
      * Creates a new instance of a media object. Don't create OdinMedia directly, use `createAudioStream` from OdinRoom instead.
-     * @param room {OdinRoom} The room to add the media to.
-     * @param sampleRate {number} The sample rate of the audio stream (between 8000 and 48000)
-     * @param channelCount {number} The number of channels of the audio stream (1 or 2)
+     * @param room - The room to add the media to.
+     * @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)
      */
     constructor(room: OdinRoom, sampleRate: number, channelCount: number);
 
@@ -22,12 +22,13 @@ export declare class OdinMedia {
      * 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.
-     * @param data
+     * @param data - A 32-bit float array containing the audio data.
      */
     sendAudioData(data: Float32Array): void;
 
     /**
      * Gets the ID of the media.
+     * @returns The ID of the media.
      */
     get id(): string;
 }

package/odin.room.d.ts

@@ -1,5 +1,8 @@
 import {OdinMedia} from "./odin.media";
 
+/**
+ * Defines available Odin events
+ */
 declare interface OdinEvents {
     /**
      * Fired when the local user connected to the room (successfully joined).
@@ -399,52 +402,52 @@ 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.
-     * @param token {string} The token to use for this room.
+     * @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 {string} The gateway URL to connect to. Use gateway.odin.4players.io if you are unsure.
-     * @param userData {Uint8Array} The user data to send to the room. This can be used to identify the user.
+     * @param gatewayUrl - The gateway URL to connect to. 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;
 
     /**
      * Sends a message to the room.
-     * @param message {Uint8Array} The message to send as a byte array.
-     * @param 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.
+     * @param message - The message to send as a byte array.
+     * @param peerIdList - 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.
      */
     sendMessage(message: Uint8Array, peerIdList?: number[]): void;
 
     /**
      * Adds an event listener to the room for specific events.
-     * @param event {Event} The event to listen for (see keys of OdinEvents for possible values)
-     * @param callback {(data: any) => void} The callback to call when the event is fired.
+     * @param eventName - The event to listen for (see keys of OdinEvents for possible values)
+     * @param handler - The callback to call when the event is fired.
      */
     addEventListener<Event extends keyof OdinEvents>(eventName: Event, handler: OdinEvents[Event]): void;
 
     /**
      * Removes an event listener from the room for specific events.
-     * @param event {Event} The event to remove the listener from (see keys of OdinEvents for possible values)
+     * @param eventName - The event to remove the listener from (see keys of OdinEvents for possible values)
      */
     removeEventListener<Event extends keyof OdinEvents>(eventName: Event): void;
 
     /**
      * Sets a global event listener that received all events, this can be helpful for debugging. Please use addEventListener instead for production code.
-     * @param callback {(data: any) => void} The callback to call when the event is fired.
+     * @param callback - The callback to call when the event is fired.
      */
     setEventListener(callback: (data: OdinEventPayload) => void): void;
 
     /**
      * Updates the peer user data of the local peer
-     * @param userData {Uint8Array} The new user data to set.
+     * @param userData - The new user data to set.
      */
     updateOwnUserData(userData: Uint8Array): void;
 
     /**
      * Updates the room user data (for all peers)
-     * @param userData {Uint8Array} The new user data to set.
+     * @param userData - The new user data to set.
      */
     updateRoomUserData(userData: Uint8Array): void;
 
@@ -466,8 +469,9 @@ export declare class OdinRoom {
     /**
      * Creates a local audio stream and adds it to the room. An OdinMedia object will be returned that allows you to send
      * audio data.
-     * @param sampleRate {number} The sample rate of the audio stream. Can be between 8000 and 48000.
-     * @param channels {number} The number of channels of the audio stream. Can be 1 or 2.
+     * @param sampleRate - The sample rate of the audio stream. Can be between 8000 and 48000.
+     * @param channels - The number of channels of the audio stream. Can be 1 or 2.
+     * @returns The OdinMedia object that allows you to send audio data.
      */
     createAudioStream(sampleRate: number, channels: number, apmSettings?: OdinAPMSettings): OdinMedia;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-nodejs",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "",
   "main": "index.cjs",
   "types": "index.d.ts",
@@ -32,7 +32,8 @@
   },
   "devDependencies": {
     "node-gyp": "^9.3.1",
-    "prebuildify": "^5.0.1"
+    "prebuildify": "^5.0.1",
+    "typedoc": "^0.23.28"
   },
   "engines": {
     "node": ">=18"