@stinkycomputing/sesame-api-client 1.5.0-alpha.8 → 1.5.0

package/dist/index.mjs

@@ -23682,6 +23682,22 @@ var CommandList = class {
     };
     return this.add(item, timeOffsetMs);
   }
+  /**
+   * Replace the server's entire metadata routing table with the supplied bindings.
+   *
+   * Each binding is either **outbound** or **inbound** - not both:
+   *
+   * - **Outbound** (`IMetadataOutboundBinding`): when `publishMetadata(nodeId, metadataId)`
+   *   is called (or the server pushes periodic state), the payload is forwarded to every
+   *   `(outputId, trackName)` pair that matches `(sourceId, metadataId)`.
+   *
+   * - **Inbound** (`IMetadataInboundBinding`): when a streaming source receives a
+   *   `FRAME_TYPE_DATA` frame on `trackName`, it is routed to `targetId` and emitted
+   *   as a `MetadataEvent` on `EVENT_TOPIC_METADATA`.
+   *
+   * This command replaces the **entire** table - pass all desired bindings at once.
+   * An empty array clears all routing.
+   */
   setMetadataBindings(bindings, timeOffsetMs) {
     const item = new sesame.v1.commands.CommandListItem();
     item.setMetadataBindings = { bindings };
@@ -24440,6 +24456,21 @@ var SesameClient = class extends EventEmitter3 {
       await this.rpc.service.executeCommandList(cl.getCommandListMsg());
     }
   }
+  /**
+   * Publish a data-frame payload to all outbound targets registered for
+   * `(nodeId, metadataId)` in the current MetadataRouter binding table.
+   *
+   * The server resolves the binding table entry for the given `(nodeId, metadataId)`
+   * pair and sends a `FRAME_TYPE_DATA` frame to each configured `(outputId, trackName)`
+   * target. If no outbound binding exists a warning is logged server-side and the call
+   * is a no-op.
+   *
+   * @param nodeId     ID of the publishing node (source, mixer, or other engine node).
+   * @param metadataId Routing key - must match the `metadata_id` field in the binding.
+   * @param payload    Raw frame payload bytes. For `DATA_TYPE_JSON` this must be valid
+   *                   UTF-8 encoded JSON; for `DATA_TYPE_BINARY` it is opaque bytes.
+   * @param dataType   Wire encoding of the payload (defaults to `DATA_TYPE_JSON`).
+   */
   async publishMetadata(nodeId, metadataId, payload, dataType = DataType.DATA_TYPE_JSON) {
     await this.rpc.service.publishMetadata({ nodeId, metadataId, payload, dataType });
   }