@stinkycomputing/sesame-api-client 1.5.0-alpha.8 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +433 -433
- package/dist/command-list.d.ts +16 -0
- package/dist/command-list.d.ts.map +1 -1
- package/dist/index.browser.mjs +31 -0
- package/dist/index.browser.mjs.map +2 -2
- package/dist/index.cjs +31 -0
- package/dist/index.cjs.map +2 -2
- package/dist/index.mjs +31 -0
- package/dist/index.mjs.map +2 -2
- package/dist/sesame-api-client.d.ts +15 -0
- package/dist/sesame-api-client.d.ts.map +1 -1
- package/docs/protocol-reference.md +2 -2
- package/package.json +1 -1
|
@@ -68,6 +68,21 @@ export declare class SesameClient extends EventEmitter {
|
|
|
68
68
|
getService(): RPCClient<sesame.v1.rpc.SesameAPIService>;
|
|
69
69
|
requestKeyframe(outputId: string): Promise<void>;
|
|
70
70
|
execute(cl: CommandList): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Publish a data-frame payload to all outbound targets registered for
|
|
73
|
+
* `(nodeId, metadataId)` in the current MetadataRouter binding table.
|
|
74
|
+
*
|
|
75
|
+
* The server resolves the binding table entry for the given `(nodeId, metadataId)`
|
|
76
|
+
* pair and sends a `FRAME_TYPE_DATA` frame to each configured `(outputId, trackName)`
|
|
77
|
+
* target. If no outbound binding exists a warning is logged server-side and the call
|
|
78
|
+
* is a no-op.
|
|
79
|
+
*
|
|
80
|
+
* @param nodeId ID of the publishing node (source, mixer, or other engine node).
|
|
81
|
+
* @param metadataId Routing key - must match the `metadata_id` field in the binding.
|
|
82
|
+
* @param payload Raw frame payload bytes. For `DATA_TYPE_JSON` this must be valid
|
|
83
|
+
* UTF-8 encoded JSON; for `DATA_TYPE_BINARY` it is opaque bytes.
|
|
84
|
+
* @param dataType Wire encoding of the payload (defaults to `DATA_TYPE_JSON`).
|
|
85
|
+
*/
|
|
71
86
|
publishMetadata(nodeId: string, metadataId: string, payload: Uint8Array, dataType?: sesame.v1.wire.DataType): Promise<void>;
|
|
72
87
|
disconnect(): void;
|
|
73
88
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sesame-api-client.d.ts","sourceRoot":"","sources":["../src/sesame-api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAoB,MAAM,qBAAqB,CAAA;AAE3E,OAAO,EAAkB,SAAS,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,oBAAY,QAAQ;IAClB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,YAAY,gBAAgB;IAC5B,aAAa,iBAAiB;IAC9B,eAAe,mBAAmB;IAClC,QAAQ,YAAY;IACpB,SAAS,aAAa;IACtB,WAAW,eAAe;IAC1B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,aAAa,iBAAiB;IAC9B,cAAc,kBAAkB;IAChC,gBAAgB,oBAAoB;IACpC,cAAc,kBAAkB;IAChC,eAAe,mBAAmB;IAClC,iBAAiB,qBAAqB;IACtC,WAAW,eAAe;IAC1B,YAAY,gBAAgB;IAC5B,cAAc,kBAAkB;IAChC,SAAS,aAAa;IACtB,UAAU,cAAc;IACxB,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,OAAO,WAAW;IAClB,QAAQ,YAAY;IACpB,UAAU,cAAc;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAA;CACxE;AAED,UAAU,eAAe;IACvB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC;AAOD,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,GAAG,CAA4C;IACvD,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,aAAa,CAA2B;IAEhD,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,QAAQ,EAAE,WAAW,CAAC;IACtC,SAAgB,IAAI,EAAE,OAAO,CAAC;IAEvB,aAAa,EAAE,mBAAmB,CAAY;IAC9C,iBAAiB,EAAE,eAAe,CAAY;IAE9C,WAAW,IAAI,OAAO;gBAIjB,SAAS,EAAE,MAAM,GAAG,MAAM;IAiEtC,OAAO,CAAC,iBAAiB;IAYlB,oBAAoB,CAAC,EAAE,EAAE,MAAM;IAK/B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,iBAAiB;IAU/E,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,iBAAiB;IAKlF,UAAU;IAIJ,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhD,OAAO,CAAC,EAAE,EAAE,WAAW;
|
|
1
|
+
{"version":3,"file":"sesame-api-client.d.ts","sourceRoot":"","sources":["../src/sesame-api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAoB,MAAM,qBAAqB,CAAA;AAE3E,OAAO,EAAkB,SAAS,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,oBAAY,QAAQ;IAClB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,YAAY,gBAAgB;IAC5B,aAAa,iBAAiB;IAC9B,eAAe,mBAAmB;IAClC,QAAQ,YAAY;IACpB,SAAS,aAAa;IACtB,WAAW,eAAe;IAC1B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,aAAa,iBAAiB;IAC9B,cAAc,kBAAkB;IAChC,gBAAgB,oBAAoB;IACpC,cAAc,kBAAkB;IAChC,eAAe,mBAAmB;IAClC,iBAAiB,qBAAqB;IACtC,WAAW,eAAe;IAC1B,YAAY,gBAAgB;IAC5B,cAAc,kBAAkB;IAChC,SAAS,aAAa;IACtB,UAAU,cAAc;IACxB,YAAY,gBAAgB;IAC5B,UAAU,cAAc;IACxB,WAAW,eAAe;IAC1B,aAAa,iBAAiB;IAC9B,OAAO,WAAW;IAClB,QAAQ,YAAY;IACpB,UAAU,cAAc;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAA;CACxE;AAED,UAAU,eAAe;IACvB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC;AAOD,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,GAAG,CAA4C;IACvD,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,aAAa,CAA2B;IAEhD,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,QAAQ,EAAE,WAAW,CAAC;IACtC,SAAgB,IAAI,EAAE,OAAO,CAAC;IAEvB,aAAa,EAAE,mBAAmB,CAAY;IAC9C,iBAAiB,EAAE,eAAe,CAAY;IAE9C,WAAW,IAAI,OAAO;gBAIjB,SAAS,EAAE,MAAM,GAAG,MAAM;IAiEtC,OAAO,CAAC,iBAAiB;IAYlB,oBAAoB,CAAC,EAAE,EAAE,MAAM;IAK/B,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,iBAAiB;IAU/E,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,iBAAiB;IAKlF,UAAU;IAIJ,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhD,OAAO,CAAC,EAAE,EAAE,WAAW;IAOpC;;;;;;;;;;;;;;OAcG;IACU,eAAe,CAC1B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,UAAU,EACnB,QAAQ,GAAE,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,QAAkC,GAC1D,OAAO,CAAC,IAAI,CAAC;IAIT,UAAU;CAGlB"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!-- Generated from .proto files
|
|
1
|
+
<!-- Generated from .proto files - do not edit manually. -->
|
|
2
2
|
<!-- Regenerate: cmake --build build --target proto-docs -->
|
|
3
3
|
|
|
4
4
|
# Sesame Protocol Reference
|
|
@@ -2177,7 +2177,7 @@ Address format: `processor_id` for preprocessor parameters.
|
|
|
2177
2177
|
| `<param_id>` | float | Preprocessor parameter (numeric ID as string) |
|
|
2178
2178
|
|
|
2179
2179
|
|
|
2180
|
-
<!-- Hand-maintained sections
|
|
2180
|
+
<!-- Hand-maintained sections - appended to generated protocol-reference.md -->
|
|
2181
2181
|
<!-- Scene Graph Properties are now auto-generated from property-registry.h -->
|
|
2182
2182
|
|
|
2183
2183
|
## Event Subscriptions
|
package/package.json
CHANGED