mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-09-11 15:09:27 +00:00
work on auto-generating parts of docs from JSONSchema
This commit is contained in:
Joel Wetzell
@@ -4,11 +4,13 @@ sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `artnet.packet.decode`
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will decode incoming bytes into an ArtNet packet. This processor will return an error if the message being processed is not an array of bytes.
|
||||
|
||||
<SchemaInfo type="processor" id="artnet.packet.decode"/>
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
|
||||
@@ -4,9 +4,12 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will encode an ArtNet packet into an array of bytes. This processor will return an error if the message being processed is not an ArtNet packet.
|
||||
|
||||
<SchemaInfo type="processor" id="artnet.packet.encode"/>
|
||||
|
||||
- **type**: `artnet.packet.encode`
|
||||
This processor will encode an ArtNet packet into an array of bytes. This processor will return an error if the message being processed is not an ArtNet packet.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,15 +4,13 @@ sidebar:
|
||||
label: Query
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
|
||||
The module must implement the `DatabaseModule` interface for this processor to work.
|
||||
This processor will return an error if any of the required parameters are missing/invalid or if the module does not implement the `DatabaseModule` interface.
|
||||
|
||||
- **type**: `db.query`
|
||||
- **params**:
|
||||
- **module**: the id of the [module](/concepts/modules) to issue query to.
|
||||
- **query**: the query to execute.
|
||||
<SchemaInfo type="processor" id="db.query"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,9 +4,11 @@ sidebar:
|
||||
label: Log
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
- **type**: `debug.log`
|
||||
This processor will log information about the message being processed to the console. This processor does not modify the message in any way and will pass the message through to the next processor in the chain.
|
||||
This processor will log information about the message being processed to the console. This processor does not modify the message in any way and will pass the message through to the next processor in the chain.
|
||||
|
||||
<SchemaInfo type="processor" id="debug.log"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: On Change
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will only pass messages through if the value of the message has changed since the last time a message was processed. This processor is useful for filtering out duplicate messages that may be emitted by a module or processor.
|
||||
|
||||
- **type**: `filter.change`
|
||||
<SchemaInfo type="processor" id="filter.change"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Expr
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `filter.expr` processor evaluates an [Expr expression](https://expr-lang.org/playground). If the expression evaluates to true then the payload is sent through. This processor will return an error if the expression fails to evaluate.
|
||||
|
||||
- **type**: `filter.expr`
|
||||
- **params**:
|
||||
- **expression**: [Expr expression](https://expr-lang.org/playground) to evaluate. The expression has access to the [wrapped payload](/concepts/payload).
|
||||
<SchemaInfo type="processor" id="filter.expr"/>
|
||||
|
||||
### Example
|
||||
|
||||
@@ -18,5 +17,5 @@ Match a payload great than or equal to 0
|
||||
```yaml
|
||||
- type: filter.expr
|
||||
params:
|
||||
pattern: "Payload >= 0"
|
||||
expression: "Payload >= 0"
|
||||
```
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Regex
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `filter.regex` processor matches incoming string payload against a regular expression. If there is a match then the payload is sent through. This processor will return an error if the message being processed is not a string.
|
||||
|
||||
- **type**: `filter.regex`
|
||||
- **params**:
|
||||
- **pattern**: regex pattern to match against the incoming string
|
||||
<SchemaInfo type="processor" id="filter.regex"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Parse
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `float.parse` processor takes a string and parses it as a float with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into a float.
|
||||
|
||||
- **type**: `float.parse`
|
||||
- **params**:
|
||||
- **bitSize**: (optional) the bit size of the float to parse, defaults to 64
|
||||
<SchemaInfo type="processor" id="float.parse"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: Random
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `float.random` processor will set the payload to a random float between the specified `min` and `max` value.
|
||||
|
||||
- **type**: `float.random`
|
||||
- **params**:
|
||||
- **bitSize**: (optional) the bit size of the float to generate, defaults to 32
|
||||
- **min**: the minimum value for the random float (inclusive).
|
||||
- **max**: the maximum value for the random float (exclusive).
|
||||
<SchemaInfo type="processor" id="float.random"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,25 +4,16 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a new FreeD message with the specified parameters.
|
||||
|
||||
- **type**: `free.d.create`
|
||||
- **params**:
|
||||
- **id**: the ID to set for the FreeD message
|
||||
- **pan**: the pan value to set for the FreeD message
|
||||
- **tilt**: the tilt value to set for the FreeD message
|
||||
- **roll**: the roll value to set for the FreeD message
|
||||
- **posX**: the X position value to set for the FreeD message
|
||||
- **posY**: the Y position value to set for the FreeD message
|
||||
- **posZ**: the Z position value to set for the FreeD message
|
||||
- **zoom**: the zoom value to set for the FreeD message
|
||||
- **focus**: the focus value to set for the FreeD message
|
||||
<SchemaInfo type="processor" id="freed.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- type: free.d.create
|
||||
- type: freed.create
|
||||
params:
|
||||
id: "1"
|
||||
pan: "45"
|
||||
|
||||
@@ -4,13 +4,14 @@ sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will decode incoming bytes into a FreeD message. This processor will return an error if the message being processed is not an array of bytes.
|
||||
|
||||
- **type**: `free.d.decode`
|
||||
<SchemaInfo type="processor" id="freed.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- type: free.d.decode
|
||||
- type: freed.decode
|
||||
```
|
||||
|
||||
@@ -4,13 +4,14 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will encode a FreeD message into an array of bytes. This processor will return an error if the message being processed is not a FreeD message.
|
||||
|
||||
- **type**: `free.d.encode`
|
||||
<SchemaInfo type="processor" id="freed.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- type: free.d.encode
|
||||
- type: freed.encode
|
||||
```
|
||||
|
||||
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Make Request
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This process will make an HTTP request to the specified URL using the specified method. The response will be passed through to the next processor in the chain. This processor will return an error if the request fails for any reason (e.g. network error, invalid URL, etc.).
|
||||
|
||||
- **type**: `http.request.do`
|
||||
- **params**:
|
||||
- **method**: the HTTP method to use for the request (e.g. `GET`, `POST`, `PUT`, etc.)
|
||||
- **url**: the URL to send the request to
|
||||
<SchemaInfo type="processor" id="http.request.do"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
|
||||
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
- **status**: the HTTP status code to set for the response (e.g. `200`, `404`, etc.)
|
||||
- **bodyTemplate**: the body template to set for the response
|
||||
<SchemaInfo type="processor" id="http.response.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Parse
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `int.parse` processor takes a string and parses it as an integer with the specified `base` and `bitSize`. This processor will return an error if the message being processed is not a string or if the string cannot be parsed into an integer.
|
||||
|
||||
- **type**: `int.parse`
|
||||
- **params**:
|
||||
- **base**: (optional) the base to use for parsing the integer, defaults to 10
|
||||
- **bitSize**: (optional) the bit size of the integer to parse, defaults to 64
|
||||
<SchemaInfo type="processor" id="int.parse"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -3,13 +3,11 @@ title: Create Random Int
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `int.random` processor will set the payload to a random integer between the specified `min` and `max` value.
|
||||
|
||||
- **type**: `int.random`
|
||||
- **params**:
|
||||
- **min**: the minimum value for the random integer (inclusive).
|
||||
- **max**: the maximum value for the random integer (inclusive).
|
||||
<SchemaInfo type="processor" id="int.random"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,15 +4,11 @@ sidebar:
|
||||
label: Scale
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will scale an integer value from one range to another. This processor will return an error if the message being processed is not an integer or if the parameters are not valid (e.g. if `inMin` is greater than or equal to `inMax`, etc.).
|
||||
|
||||
- **type**: `int.scale`
|
||||
- **params**:
|
||||
- **inMin**: the minimum value of the input range
|
||||
- **inMax**: the maximum value of the input range
|
||||
- **outMin**: the minimum value of the output range
|
||||
- **outMax**: the maximum value of the output range
|
||||
<SchemaInfo type="processor" id="int.scale"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Decode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
Convert an incoming byte array or raw string into a JSON object. This processor will return an error if the message being processed is not an array of bytes or a raw string, or if the bytes/string cannot be parsed as JSON.
|
||||
|
||||
- **type**: `json.decode`
|
||||
<SchemaInfo type="processor" id="json.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Encode
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will encode an incoming object into a JSON byte array. This processor will return an error if the message being processed is not able to be serialized as JSON.
|
||||
|
||||
- **type**: `json.encode`
|
||||
<SchemaInfo type="processor" id="json.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,12 @@ sidebar:
|
||||
label: Get
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `kv.get` processor gets the value associated with a key from a module that implements the `KeyValueModule` interface.
|
||||
The output payload is the value if the key is found.
|
||||
|
||||
- **type**: `kv.get`
|
||||
- **params**:
|
||||
- **module**: id of the module
|
||||
- **key**: the key to look up
|
||||
<SchemaInfo type="processor" id="kv.get"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,23 +4,19 @@ sidebar:
|
||||
label: Set
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `kv.set` processor sets the value associated with a key from a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
The `kv.set` processor sets the value of the configured key to the incoming payload using a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this processor is output unless any errors are encountered.
|
||||
|
||||
- **type**: `kv.set`
|
||||
- **params**:
|
||||
- **module**: id of the module
|
||||
- **key**: the key to look up
|
||||
- **value**: the value to set
|
||||
<SchemaInfo type="processor" id="kv.set"/>
|
||||
|
||||
### Example
|
||||
|
||||
This will attempt to set the key `hello` to `world` using the module with an id of `redis`
|
||||
This will attempt to set the key `hello` using the module with an id of `redis`
|
||||
|
||||
```yaml
|
||||
- type: kv.set
|
||||
params:
|
||||
module: redis
|
||||
key: hello
|
||||
value: world
|
||||
```
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a MIDI Control Change message with the specified channel, control number, and control value.
|
||||
|
||||
- **type**: `midi.control_change.create`
|
||||
- **params**:
|
||||
- **channel**: the MIDI channel
|
||||
- **control**: the control number
|
||||
- **value**: the control value
|
||||
<SchemaInfo type="processor" id="midi.control_change.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will decode incoming bytes into a MIDI message. This processor will return an error if the message being processed is not an array of bytes.
|
||||
|
||||
- **type**: `midi.message.decode`
|
||||
<SchemaInfo type="processor" id="midi.message.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will encode a MIDI message into an array of bytes. This processor will return an error if the message being processed is not a MIDI message.
|
||||
|
||||
- **type**: `midi.message.encode`
|
||||
<SchemaInfo type="processor" id="midi.message.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Unpack
|
||||
order: 4
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will unpack a MIDI message into its individual components. This processor will return an error if the message being processed is not a MIDI message.
|
||||
|
||||
- **type**: `midi.message.unpack`
|
||||
<SchemaInfo type="processor" id="midi.message.unpack"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -1,22 +1,19 @@
|
||||
---
|
||||
title: Create MIDI Note On
|
||||
title: Create MIDI Note Off
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a MIDI Note On message with the specified channel, note, and velocity.
|
||||
This processor will create a MIDI Note Off message with the specified channel, note, and velocity.
|
||||
|
||||
- **type**: `midi.note_on.create`
|
||||
- **params**:
|
||||
- **channel**: the MIDI channel
|
||||
- **note**: the note number
|
||||
- **velocity**: the velocity
|
||||
<SchemaInfo type="processor" id="midi.note_off.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- type: midi.note_on.create
|
||||
- type: midi.note_off.create
|
||||
params:
|
||||
channel: "1"
|
||||
note: "60"
|
||||
|
||||
@@ -1,22 +1,19 @@
|
||||
---
|
||||
title: Create MIDI Note Off
|
||||
title: Create MIDI Note On
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a MIDI Note Off message with the specified channel, note, and velocity.
|
||||
This processor will create a MIDI Note On message with the specified channel, note, and velocity.
|
||||
|
||||
- **type**: `midi.note_off.create`
|
||||
- **params**:
|
||||
- **channel**: the MIDI channel
|
||||
- **note**: the note number
|
||||
- **velocity**: the velocity
|
||||
<SchemaInfo type="processor" id="midi.note_on.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- type: midi.note_off.create
|
||||
- type: midi.note_on.create
|
||||
params:
|
||||
channel: "1"
|
||||
note: "60"
|
||||
|
||||
@@ -4,13 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a MIDI Program Change message with the specified channel and program number.
|
||||
|
||||
- **type**: `midi.program_change.create`
|
||||
- **params**:
|
||||
- **channel**: the MIDI channel
|
||||
- **program**: the program number
|
||||
<SchemaInfo type="processor" id="midi.program_change.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Output
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `module.output` processor takes any payload and outputs to the specified module.
|
||||
|
||||
- **type**: `module.output`
|
||||
- **params**:
|
||||
- **module**: the id of the [module](/concepts/modules) to output to.
|
||||
<SchemaInfo type="processor" id="module.output"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create an OSC message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type. The address parameter is required, while the args and types parameters are optional. However, if args are provided, then types must also be provided and must match the amount of args provided.
|
||||
|
||||
- **type**: `osc.message.create`
|
||||
- **params**:
|
||||
- **address**: the address of the OSC message.
|
||||
- **args**: (optional) array of string templates for each argument.
|
||||
- **types**: (optional) a single string with the of each arg in order. This is required if args are provided.
|
||||
<SchemaInfo type="processor" id="osc.message.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `osc.message.decode` processor takes a array of bytes and turn it into OSC message if it can be. This processor will return an error if the bytes cannot be parsed as an OSC message
|
||||
|
||||
- **type**: `osc.message.decode`
|
||||
<SchemaInfo type="processor" id="osc.message.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `osc.message.encode` processor takes an OSC message and turns it into an array of bytes. This processor will return an error if the OSC message cannot be turned into bytes.
|
||||
|
||||
- **type**: `osc.message.encode`
|
||||
<SchemaInfo type="processor" id="osc.message.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,15 +4,13 @@ sidebar:
|
||||
label: Publish
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will publish the incoming payload to a module that implements the `PubSubModule` interface.
|
||||
This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
|
||||
The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
|
||||
- **type**: `pubsub.publish`
|
||||
- **params**:
|
||||
- **module**: the module to publish with.
|
||||
- **topic**: the subject to publish to.
|
||||
<SchemaInfo type="processor" id="pubsub.publish"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Expr
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The processor will execute the provided Expr expression and return the result as the new payload. This processor will return an error if the expression cannot be executed or if there is an error during execution. The expression will have access to the [wrapped payload](/concepts/payloads).
|
||||
|
||||
- **type**: `script.expr`
|
||||
- **params**:
|
||||
- **expression**: the Expr expressiont to execute.
|
||||
<SchemaInfo type="processor" id="script.expr"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ sidebar:
|
||||
label: JavaScript
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `script.js` processor takes in any payload type and executes a JavaScript function that is able to process the payload. The end value of `payload` will be returned as the output of the processor.
|
||||
|
||||
@@ -11,9 +12,7 @@ Ending with a `payload` value of `undefined` is treated the same as any other pr
|
||||
|
||||
This run your JavaScript program in a [sandboxed environment](https://gitlab.com/cznic/quickjs). It currently support the [ES2023](https://tc39.es/ecma262/2023/) specification.
|
||||
|
||||
- **type**: `script.js`
|
||||
- **params**:
|
||||
- **program**: The JavaScript program to run. The payload is available as a global variable called `payload`.
|
||||
<SchemaInfo type="processor" id="script.js"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: WASM
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will load and execute a WASM plugin using the [Extism](https://extism.org/) runtime. The processor will execute the specified function in the WASM plugin and return the result as the new payload. This processor will return an error if the plugin cannot be loaded, if the function cannot be executed, or if there is an error during execution. The incoming payload will be passed as the argument to the WASM function. If the plugin is successfully executed, the result of the function will be returned as the new payload.
|
||||
|
||||
- **type**: `script.wasm`
|
||||
- **params**:
|
||||
- **path**: the path to the WASM plugin to load.
|
||||
- **function**: (optional) the function to execute in the WASM plugin defaults to `process`
|
||||
- **enableWasi**: (optional) whether to enable WASI for the plugin defaults to `false`
|
||||
<SchemaInfo type="processor" id="script.wasm"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
|
||||
|
||||
- **type**: `sip.response.audio.create`
|
||||
- **params**:
|
||||
- **preWait**: the amount of time in milliseconds to wait before sending the response
|
||||
- **audioFile**: the path to the audio file to include in the response
|
||||
- **postWait**: the amount of time in milliseconds to wait after sending the response
|
||||
<SchemaInfo type="processor" id="sip.response.audio.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,14 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../../../components/SchemaInfo.astro';
|
||||
|
||||
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
|
||||
|
||||
- **type**: `sip.response.dtmf.create`
|
||||
- **params**:
|
||||
- **preWait**: the amount of time in milliseconds to wait before sending the response
|
||||
- **digits**: the DTMF digits to include in the response
|
||||
- **postWait**: the amount of time in milliseconds to wait after sending the response
|
||||
<SchemaInfo type="processor" id="sip.response.dtmf.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.create` processor creates a string based on the provided template. This processor will return an error if there is an issue executing the template. The template property is just a [Go template](https://pkg.go.dev/text/template) that will be evaluated with the incoming message provided as an environment.
|
||||
|
||||
- **type**: `string.create`
|
||||
- **params**:
|
||||
- **template**: string template that will have the incoming message as the context
|
||||
<SchemaInfo type="processor" id="string.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.decode` processor takes a array of bytes and turn it into string. This processor will return an error if the message being processed is not an array of bytes.
|
||||
|
||||
- **type**: `string.decode`
|
||||
<SchemaInfo type="processor" id="string.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.encode` processor takes a string and turns it into an array of bytes. This processor will return an error if the message being processed is not a string.
|
||||
|
||||
- **type**: `string.encode`
|
||||
<SchemaInfo type="processor" id="string.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Split
|
||||
order: 5
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.split` processor takes a string and turns it into an array of strings by splitting on `params.separator`. This processor will return an error if the message being processed is not a string.
|
||||
|
||||
- **type**: `string.split`
|
||||
- **params**:
|
||||
- **pattern**: string to split incoming string on
|
||||
<SchemaInfo type="processor" id="string.split"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Sleep
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor.
|
||||
|
||||
- **type**: `time.sleep`
|
||||
- **params**:
|
||||
- **duration**: the duration to sleep in milliseconds
|
||||
<SchemaInfo type="processor" id="time.sleep"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user