mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-13 21:14:17 +00:00
add layout for remaining processors/modules and order everything
This commit is contained in:
Joel Wetzell
+193
-61
@@ -1,104 +1,210 @@
|
||||
import starlight from '@astrojs/starlight';
|
||||
import { defineConfig } from 'astro/config';
|
||||
import starlight from "@astrojs/starlight";
|
||||
import { defineConfig } from "astro/config";
|
||||
|
||||
// https://astro.build/config
|
||||
export default defineConfig({
|
||||
integrations: [
|
||||
starlight({
|
||||
title: 'showbridge',
|
||||
favicon: '/favicon.ico',
|
||||
title: "showbridge",
|
||||
favicon: "/favicon.ico",
|
||||
social: [
|
||||
{
|
||||
icon: 'github',
|
||||
label: 'GitHub',
|
||||
href: 'https://github.com/jwetzell/showbridge-go',
|
||||
icon: "github",
|
||||
label: "GitHub",
|
||||
href: "https://github.com/jwetzell/showbridge-go",
|
||||
},
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
label: 'showbridge',
|
||||
autogenerate: { directory: '/showbridge' },
|
||||
label: "showbridge",
|
||||
autogenerate: { directory: "/showbridge" },
|
||||
},
|
||||
{
|
||||
label: 'Run',
|
||||
autogenerate: { directory: 'run' },
|
||||
label: "Run",
|
||||
autogenerate: { directory: "run" },
|
||||
},
|
||||
{
|
||||
label: 'Concepts',
|
||||
autogenerate: { directory: 'concepts' },
|
||||
label: "Concepts",
|
||||
autogenerate: { directory: "concepts" },
|
||||
},
|
||||
{
|
||||
label: 'Modules',
|
||||
label: "Modules",
|
||||
items: [
|
||||
{
|
||||
label: "Time",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/time' }
|
||||
},
|
||||
{
|
||||
label: "Database",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/db' }
|
||||
},
|
||||
{
|
||||
label: "Network",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/network' }
|
||||
autogenerate: { directory: "modules/db" },
|
||||
},
|
||||
{
|
||||
label: "HTTP",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/http' }
|
||||
autogenerate: { directory: "modules/http" },
|
||||
},
|
||||
{
|
||||
label: "MIDI",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/midi' }
|
||||
},
|
||||
{
|
||||
label: "Serial",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/serial' }
|
||||
autogenerate: { directory: "modules/midi" },
|
||||
},
|
||||
{
|
||||
label: "MQTT",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/mqtt' }
|
||||
autogenerate: { directory: "modules/mqtt" },
|
||||
},
|
||||
{
|
||||
label: "NATS",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/nats" },
|
||||
},
|
||||
{
|
||||
label: "Network",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "TCP",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/net/tcp" },
|
||||
},
|
||||
{
|
||||
label: "UDP",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/net/udp" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "PosiStageNet",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/psn" },
|
||||
},
|
||||
{
|
||||
label: "Redis",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'modules/redis' }
|
||||
autogenerate: { directory: "modules/redis" },
|
||||
},
|
||||
]
|
||||
{
|
||||
label: "Time",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/time" },
|
||||
},
|
||||
{
|
||||
label: "Serial",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/serial" },
|
||||
},
|
||||
{
|
||||
label: "SIP",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Call",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/sip/call" },
|
||||
},
|
||||
{
|
||||
label: "DTMF",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "modules/sip/dtmf" },
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Processors',
|
||||
label: "Processors",
|
||||
items: [
|
||||
{
|
||||
label: "Router",
|
||||
label: "ArtNet",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/router' }
|
||||
autogenerate: { directory: "processors/artnet" },
|
||||
},
|
||||
{
|
||||
label: "Database",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/db' }
|
||||
autogenerate: { directory: "processors/db" },
|
||||
},
|
||||
{
|
||||
label: "Debug",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/debug" },
|
||||
},
|
||||
{
|
||||
label: "Filter",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/filter' }
|
||||
},
|
||||
{
|
||||
label: "Int",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/int' }
|
||||
autogenerate: { directory: "processors/filter" },
|
||||
},
|
||||
{
|
||||
label: "Float",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/float' }
|
||||
autogenerate: { directory: "processors/float" },
|
||||
},
|
||||
{
|
||||
label: "FreeD",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/free-d" },
|
||||
},
|
||||
{
|
||||
label: "HTTP",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Request",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/http/request" },
|
||||
},
|
||||
{
|
||||
label: "Response",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/http/response" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "Int",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/int" },
|
||||
},
|
||||
{
|
||||
label: "JSON",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/json" },
|
||||
},
|
||||
{
|
||||
label: "Key/Value",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/kv" },
|
||||
},
|
||||
{
|
||||
label: "MIDI",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Message",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/midi/message" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "MQTT",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Message",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/mqtt/message" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "NATS",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Message",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/nats/message" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "OSC",
|
||||
@@ -107,35 +213,61 @@ export default defineConfig({
|
||||
{
|
||||
label: "Message",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/osc/message' }
|
||||
}
|
||||
]
|
||||
autogenerate: { directory: "processors/osc/message" },
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "String",
|
||||
label: "Router",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/string' }
|
||||
autogenerate: { directory: "processors/router" },
|
||||
},
|
||||
{
|
||||
label: "Script",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/script' }
|
||||
autogenerate: { directory: "processors/script" },
|
||||
},
|
||||
{
|
||||
label: "SIP",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Response",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
label: "Audio",
|
||||
collapsed: true,
|
||||
autogenerate: {
|
||||
directory: "processors/sip/response/audio",
|
||||
},
|
||||
},
|
||||
{
|
||||
label: "DTMF",
|
||||
collapsed: true,
|
||||
autogenerate: {
|
||||
directory: "processors/sip/response/dtmf",
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: "String",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: "processors/string" },
|
||||
},
|
||||
{
|
||||
label: "Time",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/time' }
|
||||
autogenerate: { directory: "processors/time" },
|
||||
},
|
||||
{
|
||||
label: "Key/Value",
|
||||
collapsed: true,
|
||||
autogenerate: { directory: 'processors/kv' }
|
||||
}
|
||||
]
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Examples',
|
||||
autogenerate: { directory: 'examples' },
|
||||
label: "Examples",
|
||||
autogenerate: { directory: "examples" },
|
||||
},
|
||||
],
|
||||
}),
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: HTTP Server
|
||||
sidebar:
|
||||
label: Server
|
||||
order: 2
|
||||
---
|
||||
The `http.server` module emits a message for every HTTP request that is made to the server.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: MIDI Input
|
||||
sidebar:
|
||||
label: Input
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: MIDI Output
|
||||
sidebar:
|
||||
label: Output
|
||||
order: 2
|
||||
---
|
||||
import { Aside } from '@astrojs/starlight/components';
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: MQTT Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: NATS Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `nats.client`
|
||||
- **params**:
|
||||
- **url**
|
||||
- **subject**
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: NATS Server
|
||||
sidebar:
|
||||
label: Server
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `nats.server`
|
||||
- **params**:
|
||||
- **ip**
|
||||
- **port**
|
||||
+1
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: TCP Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
The `net.tcp.client` module connects to TCP server and emits messages based on the data it receives from the server that it connects to. Messages are determined by "framing" techniques as TCP is a stream based protocol. The module will attempt to reconnect anytime the connection is closed.
|
||||
+1
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: TCP Server
|
||||
sidebar:
|
||||
label: Server
|
||||
order: 2
|
||||
---
|
||||
The `net.tcp.server` module emits a message messages based on the data it receives from clients that connect to it. Messages are determined by "framing" techniques as TCP is a stream based protocol.
|
||||
+2
-1
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: UDP Client
|
||||
sidebar:
|
||||
order: 3
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: UDP Multicast
|
||||
sidebar:
|
||||
label: Multicast
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `net.udp.multicast`
|
||||
- **params**:
|
||||
- **ip**
|
||||
- **port**
|
||||
- **bufferSize**
|
||||
+2
-1
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: UDP Server
|
||||
sidebar:
|
||||
order: 4
|
||||
label: Server
|
||||
order: 2
|
||||
---
|
||||
The `net.udp.server` module emits a message for every incoming UDP datagram.
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: PSN Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `psn.client`
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Redis Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Serial Client
|
||||
sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: SIP Call Server
|
||||
sidebar:
|
||||
label: Server
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.call.server`
|
||||
- **params**:
|
||||
- **ip**
|
||||
- **port**
|
||||
- **transport**
|
||||
- **userAgent**
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: SIP DTMF Server
|
||||
sidebar:
|
||||
label: Server
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.dtmf.server`
|
||||
- **params**:
|
||||
- **ip**
|
||||
- **port**
|
||||
- **transport**
|
||||
- **userAgent**
|
||||
- **separator**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode ArtNet Packet
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `artnet.packet.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode ArtNet Packet
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `artnet.packet.encode`
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Query
|
||||
title: Database Query
|
||||
sidebar:
|
||||
label: Query
|
||||
order: 1
|
||||
---
|
||||
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Debug Log
|
||||
sidebar:
|
||||
label: Log
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `debug.log`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Filter On Change
|
||||
sidebar:
|
||||
label: On Change
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `filter.change`
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Expr Filter
|
||||
sidebar:
|
||||
label: Expr
|
||||
order: 2
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Regex Filter
|
||||
sidebar:
|
||||
label: Regex
|
||||
order: 1
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Float Parse
|
||||
title: Parse Float
|
||||
sidebar:
|
||||
label: Parse
|
||||
order: 1
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Float Random
|
||||
title: Create Random Float
|
||||
sidebar:
|
||||
label: Random
|
||||
order: 2
|
||||
---
|
||||
The `float.random` processor will set the payload to a random float between the specified `min` and `max` value.
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Create FreeD
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `free.d.create`
|
||||
- **params**:
|
||||
- **id**
|
||||
- **pan**
|
||||
- **tilt**
|
||||
- **roll**
|
||||
- **posX**
|
||||
- **posY**
|
||||
- **posZ**
|
||||
- **zoom**
|
||||
- **focus**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode FreeD
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `free.d.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode FreeD
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `free.d.encode`
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Make HTTP Request
|
||||
sidebar:
|
||||
label: Make Request
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `http.request.do`
|
||||
- **params**:
|
||||
- **method**
|
||||
- **url**
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Create HTTP Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `http.response.create`
|
||||
- **params**:
|
||||
- **status**
|
||||
- **body**
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Int Parse
|
||||
title: Parse Int
|
||||
sidebar:
|
||||
label: Parse
|
||||
order: 1
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Int Random
|
||||
title: Create Random Int
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Scale Int
|
||||
sidebar:
|
||||
label: Scale
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `int.scale`
|
||||
- **params**:
|
||||
- **inMin**
|
||||
- **inMax**
|
||||
- **outMin**
|
||||
- **outMax**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode JSON
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `json.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode JSON
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `json.decode`
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Get
|
||||
title: Get Key/Value
|
||||
sidebar:
|
||||
label: Get
|
||||
order: 1
|
||||
---
|
||||
The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Set
|
||||
title: Set Key/Value
|
||||
sidebar:
|
||||
label: Set
|
||||
order: 2
|
||||
---
|
||||
The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Create MIDI Message
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `midi.message.create`
|
||||
- **params**:
|
||||
- **type**
|
||||
- **channel**
|
||||
- **note**
|
||||
- **velocity**
|
||||
- **program**
|
||||
- **control**
|
||||
- **value**
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Decode MIDI Message
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `midi.message.decode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Encode MIDI Message
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `midi.message.encode`
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Unpack MIDI Message
|
||||
sidebar:
|
||||
label: Unpack
|
||||
order: 4
|
||||
---
|
||||
|
||||
- **type**: `midi.message.unpack`
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create MQTT Message
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `mqtt.message.create`
|
||||
- **params**:
|
||||
- **topic**
|
||||
- **qos**
|
||||
- **retained**
|
||||
- **payload**
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: Create NATS Message
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `nats.message.create`
|
||||
- **params**:
|
||||
- **subject**
|
||||
- **payload**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create OSC Message
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `osc.message.create`
|
||||
- **params**:
|
||||
- **address**
|
||||
- **args**
|
||||
- **types**
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: OSC Message Decode
|
||||
title: Decode OSC Message
|
||||
sidebar:
|
||||
order: 1
|
||||
label: Decode
|
||||
order: 3
|
||||
---
|
||||
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
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: OSC Message Encode
|
||||
title: Encode OSC Message
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Router Output
|
||||
title: Output from Router
|
||||
sidebar:
|
||||
label: Output
|
||||
order: 1
|
||||
---
|
||||
The `router.output` processor takes any payload and outputs to the specified module.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Execute Expr Expression
|
||||
sidebar:
|
||||
label: Expr
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `script.expr`
|
||||
- **params**:
|
||||
- **expression**
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: JavaScript
|
||||
title: Execute JavaScript
|
||||
sidebar:
|
||||
label: JavaScript
|
||||
order: 1
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Run WASM (Extism) Plugin
|
||||
sidebar:
|
||||
label: WASM
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `script.wasm`
|
||||
- **params**:
|
||||
- **path**
|
||||
- **function**
|
||||
- **enableWasi**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create SIP Audio Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.response.audio.create`
|
||||
- **params**:
|
||||
- **preWait**
|
||||
- **audioFile**
|
||||
- **postWait**
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Create SIP DTMF Response
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 1
|
||||
---
|
||||
|
||||
- **type**: `sip.response.dtmf.create`
|
||||
- **params**:
|
||||
- **preWait**
|
||||
- **digits**
|
||||
- **postWait**
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: String Create
|
||||
title: Create String
|
||||
sidebar:
|
||||
label: Create
|
||||
order: 3
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: String Decode
|
||||
title: Decode String
|
||||
sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: String Encode
|
||||
title: Encode String
|
||||
sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: String Split
|
||||
title: Split String
|
||||
sidebar:
|
||||
label: Split
|
||||
order: 5
|
||||
---
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Sleep
|
||||
sidebar:
|
||||
label: Sleep
|
||||
order: 1
|
||||
---
|
||||
The `time.sleep` processor will sleep for the specified `duration` in milliseconds before passing the message to the next processor.
|
||||
|
||||
Reference in New Issue
Block a user