truehear-audio-library-node 1.0.0

package/dist/index.js

@@ -0,0 +1,154 @@
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+/**
+ * Create a CommonJS-compatible `require` function inside an ESM module.
+ *
+ * @remarks
+ * This package is authored as ESM (`"type": "module"`), but the native addon
+ * loader expects `require()` to resolve the compiled `.node` binary.
+ *
+ * `createRequire(import.meta.url)` gives us a local `require` function that is
+ * safe to use inside this module.
+ */
+const require = createRequire(import.meta.url);
+/**
+ * Absolute path to this module file.
+ *
+ * This is the ESM equivalent of CommonJS `__filename`.
+ */
+const __filename = fileURLToPath(import.meta.url);
+/**
+ * Absolute directory path for this module.
+ *
+ * This is the ESM equivalent of CommonJS `__dirname`.
+ */
+const __dirname = dirname(__filename);
+/**
+ * Load the native addon binding from the project root.
+ *
+ * @remarks
+ * At runtime, this file is emitted into the `dist/` directory, so `__dirname`
+ * points to `dist/`. The native loader must be pointed at the project root so
+ * it can discover:
+ *
+ * - local development builds in `build/Release`
+ * - prebuilt native binaries, if present
+ * - any supported fallback resolution paths used by `node-gyp-build`
+ *
+ * The returned object is typed as {@link NativeAudioBinding} so the public
+ * TypeScript surface stays aligned with the native implementation.
+ */
+const native = require("node-gyp-build")(join(__dirname, ".."));
+/**
+ * List available audio devices for a given direction.
+ *
+ * @param type - The device direction to query.
+ * @returns The list of devices exposed by the operating system.
+ *
+ * @example
+ * ```ts
+ * import { listDevices } from 'truehear-audio-library-node';
+ *
+ * const playbackDevices = listDevices('playback');
+ * console.log(playbackDevices);
+ * ```
+ *
+ * @example
+ * ```ts
+ * const recordingDevices = listDevices('recording');
+ * const defaultMic = recordingDevices.find((device) => device.default);
+ *
+ * if (defaultMic) {
+ *   console.log(`Default microphone: ${defaultMic.name}`);
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * for (const device of listDevices('playback')) {
+ *   console.log(`${device.default ? '[default] ' : ''}${device.name}`);
+ * }
+ * ```
+ */
+export const listDevices = native.listDevices;
+/**
+ * Set the system's default normal audio device.
+ *
+ * @remarks
+ * Use this function to switch the primary device used by standard applications.
+ *
+ * @param type - The device direction to update.
+ * @param deviceId - The native device identifier returned by {@link listDevices}.
+ *
+ * @example
+ * ```ts
+ * const devices = listDevices('playback');
+ * const speakers = devices.find((device) => device.name.includes('Speakers'));
+ *
+ * if (speakers) {
+ *   setDefaultDevice('playback', speakers.id);
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * const mics = listDevices('recording');
+ * const usbMic = mics.find((device) => device.name.includes('USB'));
+ *
+ * if (usbMic) {
+ *   setDefaultDevice('recording', usbMic.id);
+ * }
+ * ```
+ */
+export const setDefaultDevice = native.setDefaultDevice;
+/**
+ * Set the system's default communication audio device.
+ *
+ * @remarks
+ * Communication devices are typically used by calling and conferencing apps
+ * such as Teams, Zoom, Discord, and similar voice-capable software.
+ *
+ * @param type - The device direction to update.
+ * @param deviceId - The native device identifier returned by {@link listDevices}.
+ *
+ * @example
+ * ```ts
+ * const devices = listDevices('playback');
+ * const defaultPlayback = devices.find((device) => device.default);
+ *
+ * if (defaultPlayback) {
+ *   setDefaultCommunicationDevice('playback', defaultPlayback.id);
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * const recordingDevices = listDevices('recording');
+ * const headsetMic = recordingDevices.find((device) =>
+ *   device.name.toLowerCase().includes('headset'),
+ * );
+ *
+ * if (headsetMic) {
+ *   setDefaultCommunicationDevice('recording', headsetMic.id);
+ * }
+ * ```
+ */
+export const setDefaultCommunicationDevice = native.setDefaultCommunicationDevice;
+/**
+ * Default package export for consumers who prefer object-style access.
+ *
+ * @example
+ * ```ts
+ * import truehearAudio from 'truehear-audio-library-node';
+ *
+ * const devices = truehearAudio.listDevices('playback');
+ * ```
+ */
+const truehearAudio = {
+    listDevices,
+    setDefaultDevice,
+    setDefaultCommunicationDevice,
+};
+export default truehearAudio;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../node/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAmBzC;;;;;;;;;GASG;AACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAElD;;;;GAIG;AACH,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEtC;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CACtC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CACA,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,MAAM,CAAC,6BAA6B,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,aAAa,GAAG;IACpB,WAAW;IACX,gBAAgB;IAChB,6BAA6B;CAC9B,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/include/audio_device_types.h

@@ -0,0 +1,169 @@
+#ifndef TRUEHEAR_AUDIO_DEVICE_TYPES_H
+#define TRUEHEAR_AUDIO_DEVICE_TYPES_H
+
+/*
+ * Public audio device data types.
+ *
+ * This header contains only shared type definitions.
+ * It does not include Windows COM headers.
+ * It does not know about IMMDevice, IPolicyConfig, PipeWire, CoreAudio, etc.
+ *
+ * Goal:
+ *
+ *   TypeScript API shape
+ *        ↓
+ *   Clean C structs
+ *        ↓
+ *   Platform-specific implementation fills the structs
+ *
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Audio device type                                                                              */
+/* ---------------------------------------------------------------------------------------------- */
+
+/*
+ * Playback or recording device.
+ *
+ */
+typedef enum TruehearAudioDeviceType {
+  /*
+   * Output device.
+   *
+   * Examples:
+   * - speakers
+   * - headphones
+   * - HDMI output
+   */
+  TRUEHEAR_AUDIO_DEVICE_TYPE_PLAYBACK = 0,
+
+  /*
+   * Input device.
+   *
+   * Examples:
+   * - microphone
+   * - headset microphone
+   * - USB audio input
+   */
+  TRUEHEAR_AUDIO_DEVICE_TYPE_RECORDING = 1
+} TruehearAudioDeviceType;
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Audio device info                                                                                */
+/* ---------------------------------------------------------------------------------------------- */
+
+/*
+ * Information about one audio device.
+ *
+ * This is the C equivalent of the TypeScript AudioDeviceInfo type.
+ *
+ * Important memory rule:
+ *
+ *   name, id, and device are pointers.
+ *
+ * In the library implementation, these strings will usually be allocated by
+ * the library and freed by a matching cleanup function later.
+ *
+ * Callers should treat these strings as read-only.
+ */
+typedef struct TruehearAudioDeviceInfo {
+  /*
+   * Whether this device is the system default device for its type.
+   *
+   * For playback devices:
+   *   system default output device
+   *
+   * For recording devices:
+   *   system default input device
+   *
+   * 0 = false
+   * non-zero = true
+   *
+   * Note:
+   * We use int instead of bool because it is simple and stable across C/C++
+   * boundaries.
+   */
+  int is_default;
+
+  /*
+   * Whether this device is the system default communication device.
+   *
+   * On Windows this is meaningful:
+   * - Teams
+   * - Zoom
+   * - calls
+   * - communication apps
+   *
+   * On Linux/macOS this may not exist, so the implementation can set this to 0.
+   *
+   * 0 = false
+   * non-zero = true
+   */
+  int is_default_communication;
+
+  /*
+   * Playback or recording device.
+   */
+  TruehearAudioDeviceType type;
+
+  /*
+   * Friendly display name for UI.
+   *
+   * Example:
+   *
+   *   "Speakers (Realtek(R) Audio)"
+   */
+  char *name;
+
+  /*
+   * Stable identifier used to select/change devices.
+   *
+   * Platform examples:
+   *
+   *   Windows:
+   *     IMMDevice endpoint ID string
+   *
+   *   Linux:
+   *     PipeWire node ID stored as a string
+   *
+   *   macOS:
+   *     CoreAudio device identifier depending on implementation
+   */
+  char *id;
+
+} TruehearAudioDeviceInfo;
+
+/* ---------------------------------------------------------------------------------------------- */
+/* Audio device list                                                                                */
+/* ---------------------------------------------------------------------------------------------- */
+
+/*
+ * A list of audio devices returned by the library.
+ *
+ * This gives us a simple C equivalent of:
+ *
+ *   AudioDeviceInfo[]
+ */
+typedef struct TruehearAudioDeviceInfoList {
+  /*
+   * Pointer to the first device item.
+   *
+   * Can be NULL when count is 0.
+   */
+  TruehearAudioDeviceInfo *items;
+
+  /*
+   * Number of items in the list.
+   */
+  int count;
+} TruehearAudioDeviceInfoList;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* TRUEHEAR_AUDIO_DEVICE_TYPES_H */