mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-09-11 15:09:27 +00:00
fill in basic details for remaining processors/modules
This commit is contained in:
@@ -5,14 +5,32 @@ sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
This processor will create a new FreeD message with the specified parameters.
|
||||
|
||||
- **type**: `free.d.create`
|
||||
- **params**:
|
||||
- **id**
|
||||
- **pan**
|
||||
- **tilt**
|
||||
- **roll**
|
||||
- **posX**
|
||||
- **posY**
|
||||
- **posZ**
|
||||
- **zoom**
|
||||
- **focus**
|
||||
- **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
|
||||
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: free.d.create
|
||||
params:
|
||||
id: "1"
|
||||
pan: "45"
|
||||
tilt: "30"
|
||||
roll: "0"
|
||||
posX: "10"
|
||||
posY: "5"
|
||||
posZ: "15"
|
||||
zoom: "2"
|
||||
focus: "1"
|
||||
```
|
||||
@@ -5,4 +5,11 @@ sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
- **type**: `free.d.decode`
|
||||
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`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: free.d.decode
|
||||
```
|
||||
@@ -5,4 +5,11 @@ sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
- **type**: `free.d.encode`
|
||||
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`
|
||||
|
||||
### Example
|
||||
```
|
||||
- type: free.d.encode
|
||||
```
|
||||
Reference in New Issue
Block a user