mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-05-13 21:14:17 +00:00
basic processor documentation layout
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Decode
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
The osc decode module 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`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: osc.message.encode
|
||||
```
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Encode
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
The osc encode module 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`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: osc.message.encode
|
||||
```
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: Create
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
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`
|
||||
|
||||
### Example
|
||||
This would create a string using the `Address` property of the incoming message like and OSC message
|
||||
```
|
||||
- type: string.create
|
||||
params:
|
||||
template: "{{.Address}}
|
||||
```
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Decode
|
||||
sidebar:
|
||||
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.
|
||||
|
||||
- **type**: `string.decode`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: string.decode
|
||||
```
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Encode
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
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`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: string.encode
|
||||
```
|
||||
Reference in New Issue
Block a user