fill in basic details for remaining processors/modules

This commit is contained in:
Joel Wetzell
2026-03-26 17:57:08 -05:00
parent 3a92370cdd
commit cc77a35377
30 changed files with 336 additions and 66 deletions
+13 -3
View File
@@ -4,8 +4,18 @@ sidebar:
label: Client
order: 1
---
This module connects to a [NATS](https://nats.io/) server and subscribes to a subject.
- **type**: `nats.client`
- **params**:
- **url**
- **subject**
- **url**: the URL of the NATS server to connect to (e.g. `nats://localhost:4222`)
- **subject**: the subject to subscribe to
### Example
Connect to a local NATS server and subscribe to the `events` subject
```
- id: natsClient
type: nats.client
params:
url: nats://localhost:4222
subject: events
```
+13 -3
View File
@@ -4,8 +4,18 @@ sidebar:
label: Server
order: 2
---
This module starts a NATS server that listens for incoming connections.
- **type**: `nats.server`
- **params**:
- **ip**
- **port**
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `4222`
### Example
Start a local NATS server listening on port 5555
```
- id: httpServer
type: http.server
params:
ip: 127.0.0.1
port: 5555
```
+12 -3
View File
@@ -7,6 +7,15 @@ sidebar:
- **type**: `net.udp.multicast`
- **params**:
- **ip**
- **port**
- **bufferSize**
- **ip**: the multicast IP address to listen to
- **port**: the port to listen on
### Example
Listen to the mDNS multicast address on port 5353
```
- id: mdnsListener
type: net.udp.multicast
params:
ip: 224.0.0.251
port: 5353
```
+10 -1
View File
@@ -5,4 +5,13 @@ sidebar:
order: 1
---
- **type**: `psn.client`
- **type**: `psn.client`
This module listens on the [PosiStageNet](http://posistage.net/) multicast address and emits tracker states anytime a new PSN message is received.
### Example
List
```
- id: psnClient
type: psn.client
```
+16 -5
View File
@@ -4,10 +4,21 @@ sidebar:
label: Server
order: 1
---
This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections and emits call events when a new call is received. This can be used with cheap SIP gateway devices to connect an analog phone line and do interesting things like [firing QLab cues with phone calls](/examples/dial-a-cue).
- **type**: `sip.call.server`
- **params**:
- **ip**
- **port**
- **transport**
- **userAgent**
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `5060`
- **transport**: (optional) the transport protocol to use (e.g. `udp`, `tcp`, `ws`) defaults to `udp`
- **userAgent**: (optional) the User-Agent string to use in SIP responses defaults to `showbridge`
### Example
Start a UDP SIP server listening on port 5060
```
- id: sipCallServer
type: sip.call.server
params:
ip: 127.0.0.1
port: 5060
transport: udp
```
+18 -5
View File
@@ -4,11 +4,24 @@ sidebar:
label: Server
order: 1
---
This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Protocol) server that listens for incoming connections. When a call is received this module will emit events based on the touch tones (DTMF) received during the call. The event is sent out whenever the use presses the separator key defined in the params.
- **type**: `sip.dtmf.server`
- **params**:
- **ip**
- **port**
- **transport**
- **userAgent**
- **separator**
- **ip**: (optional) the IP address to bind the server to defaults to `0.0.0.0`
- **port**: (optional) the port to listen on defaults to `5060`
- **transport**: (optional) the transport protocol to use (e.g. `udp`, `tcp`, `ws`) defaults to `udp`
- **userAgent**: (optional) the User-Agent string to use in SIP responses defaults to `showbridge`
- **separator**: the DTMF separator key to know when to emit events
### Example
Start a UDP SIP server listening on port 5060 that will emit events whenever the user presses the `#` key on their phone during a call
```
- id: sipDTMFServer
type: sip.dtmf.server
params:
ip: 127.0.0.1
port: 5060
transport: udp
separator: '#'
```