Expand description
api: Defines the WebSocket API contract for StreamKit.
All API communication uses JSON for parameters and payloads. While pipeline YAML files are still supported internally, the WebSocket API contract exclusively uses JSON for consistency and TypeScript compatibility.
Modules§
- yaml
- YAML pipeline format parsing and compilation.
Structs§
- Audio
Asset - Connection
- Represents a connection between two nodes in the graph.
- Message
- Generic WebSocket message container for requests, responses, and events.
- Node
- Represents a single node’s configuration within the pipeline.
- Node
Definition - A serializable representation of a node’s definition for API exposure.
- Node
Stats - Runtime statistics for a node, tracking packet processing metrics.
- Permissions
Info - Pipeline
- The top-level structure for a pipeline definition, used by the engine and API.
- Sample
Pipeline - Save
Pipeline Request - Session
Info - Validation
Error
Enums§
- Batch
Operation - Connection
Mode - Specifies how a connection handles backpressure from slow consumers.
- Engine
Mode - Engine execution mode
- Event
Payload - Events are asynchronous notifications sent from the server to subscribed clients. Unlike responses, events are not correlated to specific requests.
- Message
Type - The type of WebSocket message being sent or received.
- Node
Control Message - A message sent to a specific, running node to tune its parameters or control its lifecycle.
- Node
State - Represents the runtime state of a node in the pipeline.
- Request
Payload - Client-to-server request payload types.
- Response
Payload - Validation
Error Type