grandi 1.3.1 → 2.0.1

package/dist/index.d.mts

@@ -3,7 +3,7 @@ declare enum FrameType {
   Interlaced = 0,
   Progressive = 1,
   Field0 = 2,
-  Field1 = 3,
+  Field1 = 3
 }
 declare enum ColorFormat {
   BGRX_BGRA = 0,
@@ -12,18 +12,18 @@ declare enum ColorFormat {
   UYVY_RGBA = 3,
   Fastest = 100,
   Best = 101,
-  BGRX_BGRA_FLIPPED = 1000,
+  BGRX_BGRA_FLIPPED = 1000
 }
 declare enum AudioFormat {
   Float32Separate = 0,
   Float32Interleaved = 1,
-  Int16Interleaved = 2,
+  Int16Interleaved = 2
 }
 declare enum Bandwidth {
   MetadataOnly = -10,
   AudioOnly = 10,
   Lowest = 0,
-  Highest = 100,
+  Highest = 100
 }
 declare enum FourCC {
   UYVY = 1498831189,
@@ -37,10 +37,17 @@ declare enum FourCC {
   BGRX = 1481787202,
   RGBA = 1094862674,
   RGBX = 1480738642,
-  FLTp = 1884572742,
+  FLTp = 1884572742
 }
-type PtpTimestamp = [number, number];
-type Timecode = bigint | number | PtpTimestamp;
+type VideoFourCC = FourCC.UYVY | FourCC.UYVA | FourCC.P216 | FourCC.PA16 | FourCC.YV12 | FourCC.I420 | FourCC.NV12 | FourCC.BGRA | FourCC.BGRX | FourCC.RGBA | FourCC.RGBX;
+type AudioFourCC = FourCC.FLTp;
+/**
+ * NDI sentinel that asks the SDK to generate synthesized timecode.
+ *
+ * @see [Synthesized timecode in the NDI SDK documentation](https://docs.ndi.video/all/getting-started/white-paper/time-timecode-and-sync-for-ndi#synthesized-timecode)
+ */
+declare const TIMECODE_SYNTHESIZE = 9223372036854775807n;
+type Timecode = bigint;
 interface Source {
   name: string;
   urlAddress?: string;
@@ -52,40 +59,45 @@ interface VideoFrame {
   frameRateN: number;
   frameRateD: number;
   pictureAspectRatio: number;
-  fourCC: FourCC;
+  fourCC: VideoFourCC;
   frameFormatType: FrameType;
   lineStrideBytes: number;
   data: Buffer;
   timecode?: Timecode;
-  /**
-   * Receive-only timestamp filled by the NDI SDK (UTC time, 100ns units under the hood).
-   * NDI ignores this field when sending.
-   */
-  timestamp?: PtpTimestamp;
   metadata?: string;
 }
 interface ReceivedVideoFrame extends VideoFrame {
   type: "video";
-  timecode: PtpTimestamp;
-  timestamp: PtpTimestamp;
+  timecode: bigint;
+  /** Omitted when the NDI SDK reports that the receive timestamp is unavailable. */
+  timestamp?: bigint;
   metadata?: string;
 }
-interface AudioFrame {
+type AudioFrame = {
   type?: "audio";
   sampleRate: number;
-  noChannels: number;
-  noSamples: number;
   channelStrideBytes: number;
   data: Buffer;
-  fourCC: FourCC;
+  fourCC: AudioFourCC;
   timecode?: Timecode;
-  /**
-   * Receive-only timestamp filled by the NDI SDK (UTC time, 100ns units under the hood).
-   * NDI ignores this field when sending.
-   */
-  timestamp?: PtpTimestamp;
   metadata?: string;
-}
+} & ({
+  channels: number;
+  /** @deprecated Use `channels` instead. */
+  noChannels?: number;
+} | {
+  channels?: number;
+  /** @deprecated Use `channels` instead. */
+  noChannels: number;
+}) & ({
+  samples: number;
+  /** @deprecated Use `samples` instead. */
+  noSamples?: number;
+} | {
+  samples?: number;
+  /** @deprecated Use `samples` instead. */
+  noSamples: number;
+});
 interface ReceivedAudioFrame {
   type: "audio";
   audioFormat: AudioFormat;
@@ -95,15 +107,15 @@ interface ReceivedAudioFrame {
   samples: number;
   channelStrideInBytes: number;
   data: Buffer;
-  timecode: PtpTimestamp;
-  timestamp: PtpTimestamp;
+  timecode: bigint;
+  /** Omitted when the NDI SDK reports that the receive timestamp is unavailable. */
+  timestamp?: bigint;
   metadata?: string;
 }
 interface ReceivedMetadataFrame {
   type: "metadata";
   length: number;
-  timecode: PtpTimestamp;
-  timestamp: PtpTimestamp;
+  timecode: bigint;
   data: string;
 }
 interface SourceChangeEvent {
@@ -120,8 +132,23 @@ interface AudioReceiveOptions {
   audioFormat?: AudioFormat;
   referenceLevel?: number;
 }
+interface ReceiverPerformance {
+  total: {
+    videoFrames: number;
+    audioFrames: number;
+    metadataFrames: number;
+  };
+  dropped: {
+    videoFrames: number;
+    audioFrames: number;
+    metadataFrames: number;
+  };
+}
+interface ReceiverQueue {
+  videoFrames: number;
+  audioFrames: number;
+}
 interface Receiver {
-  embedded: unknown;
   source: Source;
   colorFormat: ColorFormat;
   bandwidth: Bandwidth;
@@ -135,6 +162,9 @@ interface Receiver {
   data(options: AudioReceiveOptions, timeoutMs?: number): Promise<ReceiverDataFrame>;
   tally(state: ReceiverTallyState): boolean;
   destroy(): boolean;
+  performance(): ReceiverPerformance;
+  queue(): ReceiverQueue;
+  connections(): number;
 }
 interface ReceiverTallyState {
   onProgram?: boolean;
@@ -142,11 +172,14 @@ interface ReceiverTallyState {
 }
 interface SenderTally {
   changed: boolean;
+  onProgram: boolean;
+  onPreview: boolean;
+  /** @deprecated Use `onProgram` instead. */
   on_program: boolean;
+  /** @deprecated Use `onPreview` instead. */
   on_preview: boolean;
 }
 interface Sender {
-  embedded: unknown;
   name: string;
   groups?: string;
   clockVideo: boolean;
@@ -156,26 +189,42 @@ interface Sender {
   connections(): number;
   metadata(data: string): boolean;
   tally(): SenderTally;
+  sourceName(): string;
+  /** @deprecated Use `sourceName` instead. */
   sourcename(): string;
   destroy(): boolean;
 }
 interface Routing {
-  embedded: unknown;
   name?: string;
   groups?: string;
   destroy(): boolean;
-  change(source: Source): boolean;
+  change(source: Source | null | undefined): boolean;
   clear(): boolean;
   connections(): number;
+  sourceName(): string;
+  /** @deprecated Use `sourceName` instead. */
   sourcename(): string;
 }
-interface FrameSyncAudioOptions {
+interface FrameSyncAudioOptionsBase {
   sampleRate?: number;
+  channels?: number;
+  /** @deprecated Use `channels` instead. */
   noChannels?: number;
+}
+type FrameSyncAudioOptions = (FrameSyncAudioOptionsBase & {
+  samples: number;
+  /** @deprecated Use `samples` instead. */
   noSamples?: number;
+}) | (FrameSyncAudioOptionsBase & {
+  samples?: never;
+  /** @deprecated Use `samples` instead. */
+  noSamples: number;
+});
+interface FrameSyncAudioFormat {
+  sampleRate: number;
+  channels: number;
 }
 interface FrameSync {
-  embedded: unknown;
   /**
    * Captures a video frame using NDI frame-synchronization (time base correction).
    * Always returns immediately.
@@ -186,8 +235,14 @@ interface FrameSync {
   /**
    * Captures audio using NDI frame-synchronization (resampled to match your calls).
    * Always returns immediately and may insert silence if no audio is present.
+   * `samples` must be greater than zero.
+   */
+  audio(options: FrameSyncAudioOptions): Promise<ReceivedAudioFrame>;
+  /**
+   * Returns the current incoming audio format, or `undefined` when no audio
+   * format has been received yet.
    */
-  audio(options?: FrameSyncAudioOptions): Promise<ReceivedAudioFrame>;
+  audioFormat(): FrameSyncAudioFormat | undefined;
   /**
    * Returns an approximate depth of the internal audio queue in samples.
    */
@@ -196,12 +251,14 @@ interface FrameSync {
 }
 interface Finder {
   sources(): Source[];
-  wait(timeoutMs?: number): boolean;
+  wait(timeoutMs?: number): Promise<boolean>;
   destroy(): boolean;
 }
 interface FindOptions {
   showLocalSources?: boolean;
   groups?: string;
+  /** @deprecated Use `extraIPs` instead. */
+  extraIps?: string;
   extraIPs?: string;
 }
 interface ReceiveOptions {
@@ -245,9 +302,10 @@ interface Grandi {
    */
   isSupportedCPU(): boolean;
   /**
-   * Initializes the NDI library. Must be called before using any other NDI functions.
-   * Call this once per process, before creating senders/receivers/finders.
-   * @returns `true` if initialization was successful.
+   * Optionally initializes the process-global NDI library.
+   * The SDK does not require this call, but eager initialization is recommended
+   * when the application explicitly manages startup and shutdown.
+   * @returns `true` if initialization succeeded and the CPU is supported.
    *
    * @example
    * ```js
@@ -257,9 +315,9 @@ interface Grandi {
    */
   initialize(): boolean;
   /**
-   * Destroys the NDI library instance and cleans up resources.
-   * Should be called when done using NDI to free resources.
-   * @returns `true` if destruction was successful.
+   * Optionally shuts down the process-global NDI library.
+   * When managing the lifecycle explicitly, destroy all native objects first.
+   * @returns `true` after requesting shutdown.
    *
    * @example
    * ```js
@@ -293,7 +351,7 @@ interface Grandi {
    * import grandi from "grandi";
    * grandi.initialize();
    * const finder = await grandi.find({ showLocalSources: true });
-   * finder.wait(1000);
+   * await finder.wait(1000);
    * const source = finder.sources()[0];
    * finder.destroy();
    * const receiver = await grandi.receive({ source });
@@ -304,11 +362,12 @@ interface Grandi {
   receive(params: ReceiveOptions): Promise<Receiver>;
   /**
    * Creates an NDI frame-synchronizer (time base corrector) backed by an existing receiver.
-   * Use this when you want smooth playback clocked to your own render/audio loop.
-   *
-   * Note: destroy the frame-sync before destroying the receiver.
+   * While it exists, direct `video`, `audio`, and `data` captures on that
+   * receiver are unavailable; metadata and control methods such as `tally` remain usable.
+   * Destroy the frame-sync before the receiver. Direct capture becomes available
+   * again after the frame-sync is destroyed.
    */
-  framesync(receiver: Receiver): Promise<FrameSync>;
+  frameSync(receiver: Receiver): Promise<FrameSync>;
   /**
    * Creates an NDI router for switching between different NDI sources.
    * @param params Router options.
@@ -339,7 +398,7 @@ interface Grandi {
    * import grandi from "grandi";
    * grandi.initialize();
    * const finder = await grandi.find({ showLocalSources: true });
-   * finder.wait(1000);
+   * await finder.wait(1000);
    * console.log(finder.sources());
    * finder.destroy();
    * ```
@@ -349,145 +408,92 @@ interface Grandi {
    * Enum: receiver video color formats.
    */
   ColorFormat: typeof ColorFormat;
+  /** @deprecated Use `ColorFormat.BGRX_BGRA` instead. */
+  COLOR_FORMAT_BGRX_BGRA: ColorFormat.BGRX_BGRA;
+  /** @deprecated Use `ColorFormat.UYVY_BGRA` instead. */
+  COLOR_FORMAT_UYVY_BGRA: ColorFormat.UYVY_BGRA;
+  /** @deprecated Use `ColorFormat.RGBX_RGBA` instead. */
+  COLOR_FORMAT_RGBX_RGBA: ColorFormat.RGBX_RGBA;
+  /** @deprecated Use `ColorFormat.UYVY_RGBA` instead. */
+  COLOR_FORMAT_UYVY_RGBA: ColorFormat.UYVY_RGBA;
+  /** @deprecated Use `ColorFormat.Fastest` instead. */
+  COLOR_FORMAT_FASTEST: ColorFormat.Fastest;
+  /** @deprecated Use `ColorFormat.Best` instead. */
+  COLOR_FORMAT_BEST: ColorFormat.Best;
+  /** @deprecated Use `ColorFormat.BGRX_BGRA_FLIPPED` instead. */
+  COLOR_FORMAT_BGRX_BGRA_FLIPPED: ColorFormat.BGRX_BGRA_FLIPPED;
   /**
    * Enum: supported raw audio formats for helpers/receive conversions.
    */
   AudioFormat: typeof AudioFormat;
+  /** @deprecated Use `AudioFormat.Float32Separate` instead. */
+  AUDIO_FORMAT_FLOAT_32_SEPARATE: AudioFormat.Float32Separate;
+  /** @deprecated Use `AudioFormat.Float32Interleaved` instead. */
+  AUDIO_FORMAT_FLOAT_32_INTERLEAVED: AudioFormat.Float32Interleaved;
+  /** @deprecated Use `AudioFormat.Int16Interleaved` instead. */
+  AUDIO_FORMAT_INT_16_INTERLEAVED: AudioFormat.Int16Interleaved;
   /**
    * Enum: receiver bandwidth modes.
    */
   Bandwidth: typeof Bandwidth;
+  /** @deprecated Use `Bandwidth.MetadataOnly` instead. */
+  BANDWIDTH_METADATA_ONLY: Bandwidth.MetadataOnly;
+  /** @deprecated Use `Bandwidth.AudioOnly` instead. */
+  BANDWIDTH_AUDIO_ONLY: Bandwidth.AudioOnly;
+  /** @deprecated Use `Bandwidth.Lowest` instead. */
+  BANDWIDTH_LOWEST: Bandwidth.Lowest;
+  /** @deprecated Use `Bandwidth.Highest` instead. */
+  BANDWIDTH_HIGHEST: Bandwidth.Highest;
   /**
    * Enum: video frame format types (progressive/interlaced/fields).
    */
   FrameType: typeof FrameType;
+  /** @deprecated Use `FrameType.Progressive` instead. */
+  FORMAT_TYPE_PROGRESSIVE: FrameType.Progressive;
+  /** @deprecated Use `FrameType.Interlaced` instead. */
+  FORMAT_TYPE_INTERLACED: FrameType.Interlaced;
+  /** @deprecated Use `FrameType.Field0` instead. */
+  FORMAT_TYPE_FIELD_0: FrameType.Field0;
+  /** @deprecated Use `FrameType.Field1` instead. */
+  FORMAT_TYPE_FIELD_1: FrameType.Field1;
   /**
    * Enum: FourCC pixel/audio formats used in frames.
    */
   FourCC: typeof FourCC;
-  /**
-   * Alias of `ColorFormat.BGRX_BGRA`.
-   */
-  COLOR_FORMAT_BGRX_BGRA: ColorFormat;
-  /**
-   * Alias of `ColorFormat.UYVY_BGRA`.
-   */
-  COLOR_FORMAT_UYVY_BGRA: ColorFormat;
-  /**
-   * Alias of `ColorFormat.RGBX_RGBA`.
-   */
-  COLOR_FORMAT_RGBX_RGBA: ColorFormat;
-  /**
-   * Alias of `ColorFormat.UYVY_RGBA`.
-   */
-  COLOR_FORMAT_UYVY_RGBA: ColorFormat;
-  /**
-   * Alias of `ColorFormat.Fastest`.
-   */
-  COLOR_FORMAT_FASTEST: ColorFormat;
-  /**
-   * Alias of `ColorFormat.Best`.
-   */
-  COLOR_FORMAT_BEST: ColorFormat;
-  /**
-   * Alias of `ColorFormat.BGRX_BGRA_FLIPPED` (Windows-only).
-   */
-  COLOR_FORMAT_BGRX_BGRA_FLIPPED: ColorFormat;
-  /**
-   * Alias of `Bandwidth.MetadataOnly`.
-   */
-  BANDWIDTH_METADATA_ONLY: Bandwidth;
-  /**
-   * Alias of `Bandwidth.AudioOnly`.
-   */
-  BANDWIDTH_AUDIO_ONLY: Bandwidth;
-  /**
-   * Alias of `Bandwidth.Lowest`.
-   */
-  BANDWIDTH_LOWEST: Bandwidth;
-  /**
-   * Alias of `Bandwidth.Highest`.
-   */
-  BANDWIDTH_HIGHEST: Bandwidth;
-  /**
-   * Alias of `FrameType.Progressive`.
-   */
-  FORMAT_TYPE_PROGRESSIVE: FrameType;
-  /**
-   * Alias of `FrameType.Interlaced`.
-   */
-  FORMAT_TYPE_INTERLACED: FrameType;
-  /**
-   * Alias of `FrameType.Field0`.
-   */
-  FORMAT_TYPE_FIELD_0: FrameType;
-  /**
-   * Alias of `FrameType.Field1`.
-   */
-  FORMAT_TYPE_FIELD_1: FrameType;
-  /**
-   * Alias of `AudioFormat.Float32Separate`.
-   */
-  AUDIO_FORMAT_FLOAT_32_SEPARATE: AudioFormat;
-  /**
-   * Alias of `AudioFormat.Float32Interleaved`.
-   */
-  AUDIO_FORMAT_FLOAT_32_INTERLEAVED: AudioFormat;
-  /**
-   * Alias of `AudioFormat.Int16Interleaved`.
-   */
-  AUDIO_FORMAT_INT_16_INTERLEAVED: AudioFormat;
-  /**
-   * Alias of `FourCC.UYVY`.
-   */
-  FOURCC_UYVY: FourCC;
-  /**
-   * Alias of `FourCC.UYVA`.
-   */
-  FOURCC_UYVA: FourCC;
-  /**
-   * Alias of `FourCC.P216`.
-   */
-  FOURCC_P216: FourCC;
-  /**
-   * Alias of `FourCC.PA16`.
-   */
-  FOURCC_PA16: FourCC;
-  /**
-   * Alias of `FourCC.YV12`.
-   */
-  FOURCC_YV12: FourCC;
-  /**
-   * Alias of `FourCC.I420`.
-   */
-  FOURCC_I420: FourCC;
-  /**
-   * Alias of `FourCC.NV12`.
-   */
-  FOURCC_NV12: FourCC;
-  /**
-   * Alias of `FourCC.BGRA`.
-   */
-  FOURCC_BGRA: FourCC;
-  /**
-   * Alias of `FourCC.BGRX`.
-   */
-  FOURCC_BGRX: FourCC;
-  /**
-   * Alias of `FourCC.RGBA`.
-   */
-  FOURCC_RGBA: FourCC;
-  /**
-   * Alias of `FourCC.RGBX`.
-   */
-  FOURCC_RGBX: FourCC;
-  /**
-   * Alias of `FourCC.FLTp`.
+  /** @deprecated Use `FourCC.UYVY` instead. */
+  FOURCC_UYVY: FourCC.UYVY;
+  /** @deprecated Use `FourCC.UYVA` instead. */
+  FOURCC_UYVA: FourCC.UYVA;
+  /** @deprecated Use `FourCC.P216` instead. */
+  FOURCC_P216: FourCC.P216;
+  /** @deprecated Use `FourCC.PA16` instead. */
+  FOURCC_PA16: FourCC.PA16;
+  /** @deprecated Use `FourCC.YV12` instead. */
+  FOURCC_YV12: FourCC.YV12;
+  /** @deprecated Use `FourCC.I420` instead. */
+  FOURCC_I420: FourCC.I420;
+  /** @deprecated Use `FourCC.NV12` instead. */
+  FOURCC_NV12: FourCC.NV12;
+  /** @deprecated Use `FourCC.BGRA` instead. */
+  FOURCC_BGRA: FourCC.BGRA;
+  /** @deprecated Use `FourCC.BGRX` instead. */
+  FOURCC_BGRX: FourCC.BGRX;
+  /** @deprecated Use `FourCC.RGBA` instead. */
+  FOURCC_RGBA: FourCC.RGBA;
+  /** @deprecated Use `FourCC.RGBX` instead. */
+  FOURCC_RGBX: FourCC.RGBX;
+  /** @deprecated Use `FourCC.FLTp` instead. */
+  FOURCC_FLTp: FourCC.FLTp;
+  /**
+   * NDI sentinel that asks the SDK to synthesize the timecode.
+   *
+   * @see [Synthesized timecode in the NDI SDK documentation](https://docs.ndi.video/all/getting-started/white-paper/time-timecode-and-sync-for-ndi#synthesized-timecode)
    */
-  FOURCC_FLTp: FourCC;
+  TIMECODE_SYNTHESIZE: bigint;
 }
 //#endregion
 //#region src/index.d.ts
+/** @internal Native addon contract used by the JavaScript wrapper. */
 interface GrandiAddon {
   version(): string;
   isSupportedCPU(): boolean;
@@ -504,7 +510,7 @@ interface GrandiAddon {
 }
 /**
  * Creates a finder to discover NDI sources on the network.
- * @param {FindOptions} [params={}] - Options for finding sources.
+ * @param {FindOptions} params - Options for finding sources.
  * @param {boolean} [params.showLocalSources] - Whether to show local sources.
  * @param {string} [params.groups] - Multicast groups to search in.
  * @param {string} [params.extraIPs] - Additional IP addresses to search.
@@ -516,7 +522,7 @@ interface GrandiAddon {
  * import { find, initialize } from "grandi";
  * initialize();
  * const finder = await find({ showLocalSources: true });
- * finder.wait(1000);
+ * await finder.wait(1000);
  * console.log(finder.sources());
  * finder.destroy();
  * ```
@@ -533,8 +539,9 @@ declare const version: () => string;
  */
 declare const isSupportedCPU: () => boolean;
 /**
- * Initializes the NDI library. Must be called before using any other NDI functions.
- * @returns {boolean} True if initialization was successful, false otherwise.
+ * Optionally initializes the process-global NDI library. The SDK does not require
+ * this call, but eager initialization is recommended for explicit lifecycle management.
+ * @returns {boolean} True if initialization was successful and the CPU is supported.
  *
  * @example
  * ```js
@@ -544,9 +551,9 @@ declare const isSupportedCPU: () => boolean;
  */
 declare const initialize: () => boolean;
 /**
- * Destroys the NDI library instance and cleans up resources.
- * Should be called when done using NDI to free resources.
- * @returns {boolean} True if destruction was successful, false otherwise.
+ * Optionally shuts down the process-global NDI library.
+ * When managing the lifecycle explicitly, destroy all native objects before calling this.
+ * @returns {boolean} True after requesting shutdown.
  *
  * @example
  * ```js
@@ -574,7 +581,7 @@ declare const destroy: () => boolean;
  * sender.destroy();
  * ```
  */
-declare const send: (params: SendOptions) => Promise<Sender>;
+declare function send(params: SendOptions): Promise<Sender>;
 /**
  * Creates an NDI receiver for receiving video and audio from an NDI source.
  * @param {ReceiveOptions} params - Options for creating the receiver.
@@ -591,7 +598,7 @@ declare const send: (params: SendOptions) => Promise<Sender>;
  * import { find, initialize, receive } from "grandi";
  * initialize();
  * const finder = await find({ showLocalSources: true });
- * finder.wait(1000);
+ * await finder.wait(1000);
  * const source = finder.sources()[0];
  * finder.destroy();
  * const receiver = await receive({ source });
@@ -600,49 +607,14 @@ declare const send: (params: SendOptions) => Promise<Sender>;
  * ```
  */
 declare const receive: (params: ReceiveOptions) => Promise<Receiver>;
-/**
- * Creates an NDI frame-synchronizer (time base corrector) backed by an existing receiver.
- * Use this when you want smooth playback clocked to your own render/audio loop.
- *
- * Note: destroy the frame-sync before destroying the receiver.
- * @param {Receiver} receiver - The receiver instance to frame-sync.
- * @returns {Promise<FrameSync>} A promise that resolves to a FrameSync instance.
- * @throws {Error} Promise rejects on unsupported platform/CPU or if framesync creation fails.
- *
- * @example
- * ```js
- * import grandi from "grandi";
- * grandi.initialize();
- * const receiver = await grandi.receive({ source });
- * const fs = await grandi.framesync(receiver);
- * const frame = await fs.video(grandi.FrameType.Progressive);
- * fs.destroy();
- * receiver.destroy();
- * ```
- */
+declare const frameSync: (receiver: Receiver) => Promise<FrameSync>;
+/** @deprecated Use `frameSync` instead. */
 declare const framesync: (receiver: Receiver) => Promise<FrameSync>;
-/**
- * Creates an NDI router for switching between different NDI sources.
- * @param {Object} params - Options for creating the router.
- * @param {string} [params.name] - The name for the router.
- * @param {string} [params.groups] - Multicast groups for the router.
- * @returns {Promise<Routing>} A promise that resolves to a Routing instance for source switching.
- * @throws {Error} Promise rejects on unsupported platform/CPU or if routing creation fails.
- *
- * @example
- * ```js
- * import { initialize, routing } from "grandi";
- * initialize();
- * const router = await routing({ name: "My Router" });
- * // router.change(source)
- * router.destroy();
- * ```
- */
-declare const routing: (params: {
+declare function routing(params: {
   name?: string;
   groups?: string;
-}) => Promise<Routing>;
+}): Promise<Routing>;
 declare const grandi: Grandi;
 //#endregion
-export { AudioFormat, type AudioFrame, type AudioReceiveOptions, Bandwidth, ColorFormat, type FindOptions, type Finder, FourCC, type FrameSync, type FrameSyncAudioOptions, FrameType, type Grandi, GrandiAddon, type PtpTimestamp, type ReceiveOptions, type ReceivedAudioFrame, type ReceivedMetadataFrame, type ReceivedVideoFrame, type ReceiverDataFrame, type ReceiverTallyState, type Routing, type Sender, type SenderTally, type Source, type SourceChangeEvent, type StatusChangeEvent, type Timecode, type TimeoutEvent, type VideoFrame, grandi as default, destroy, find, framesync, initialize, isSupportedCPU, receive, routing, send, version };
+export { AudioFormat, type AudioFourCC, type AudioFrame, type AudioReceiveOptions, Bandwidth, ColorFormat, type FindOptions, type Finder, FourCC, type FrameSync, type FrameSyncAudioFormat, type FrameSyncAudioOptions, type FrameSyncAudioOptionsBase, FrameType, type Grandi, GrandiAddon, type ReceiveOptions, type ReceivedAudioFrame, type ReceivedMetadataFrame, type ReceivedVideoFrame, type Receiver, type ReceiverDataFrame, type ReceiverPerformance, type ReceiverQueue, type ReceiverTallyState, type Routing, type SendOptions, type Sender, type SenderTally, type Source, type SourceChangeEvent, type StatusChangeEvent, TIMECODE_SYNTHESIZE, type Timecode, type TimeoutEvent, type VideoFourCC, type VideoFrame, grandi as default, destroy, find, frameSync, framesync, initialize, isSupportedCPU, receive, routing, send, version };
 //# sourceMappingURL=index.d.mts.map