Documentation
Web API
| Preset Syntax | Index | Building from Source |
/factory/list
List all available modules
Return: text/json
/factory/describe
Describe a specific module.
Arguments
| Name | Type | Description |
|---|---|---|
| name | string | Name of the module |
Return: text/json
/pipeline/create
Create an instance of the specified module
Arguments
| Name | Type | Description |
|---|---|---|
| objectname | string | Name of the module to instance |
Return: text/json
/pipeline/remove
Disconnect and remove a instance from the Pipeline.
Arguments
| Name | Type | Description |
|---|---|---|
| objectname | string | Id of the module to remove |
Return: text/json
/pipeline/status
Return the status of the whole Pipeline.
Return: text/json
/pipeline/connect
Connect an output of a module to the input of another module
Arguments
| Name | Type | Description |
|---|---|---|
| out | string | Id of the object with output |
| outidx | integer | Index of the output in out object |
| in | string | Id of the object with in |
| inidx | integer | Index of the output in in object |
Return: text/json