PipeWire: Netjack2 manager

PipeWire 1.2.2

Loading...
Searching...
No Matches
Netjack2 manager

The netjack2 manager module listens for new netjack2 driver messages and will start a communication channel with them.

# Module Name

`libpipewire-module-netjack2-manager`

# Module Options

- `local.ifname = <str>`: interface name to use
- `net.ip =<str>`: multicast IP address, default "225.3.19.154"
- `net.port =<int>`: control port, default "19000"
- `net.mtu = <int>`: MTU to use, default 1500
- `net.ttl = <int>`: TTL to use, default 1
- `net.loop = <bool>`: loopback multicast, default false
- `netjack2.connect`: if jack ports should be connected automatically. Can also be placed per stream.
- `netjack2.sample-rate`: the sample rate to use, default 48000
- `netjack2.period-size`: the buffer size to use, default 1024
- `netjack2.encoding`: the encoding, float|opus|int, default float
- `netjack2.kbps`: the number of kilobits per second when encoding, default 64
- `audio.channels`: the number of audio ports. Can also be added to the stream props.
- `midi.ports`: the number of midi ports. Can also be added to the stream props.
- `source.props`: Extra properties for the source filter.
- `sink.props`: Extra properties for the sink filter.

# General options

Options with well-known behavior.

- PW_KEY_REMOTE_NAME
- PW_KEY_AUDIO_CHANNELS
- SPA_KEY_AUDIO_POSITION
- PW_KEY_NODE_NAME
- PW_KEY_NODE_DESCRIPTION
- PW_KEY_NODE_GROUP
- PW_KEY_NODE_VIRTUAL
- PW_KEY_MEDIA_CLASS
- PW_KEY_TARGET_OBJECT to specify the remote node.name or serial.id to link to

# Example configuration of a duplex sink/source

context.modules = [
{ name = libpipewire-module-netjack2-manager
args = {
#netjack2.connect = true
#netjack2.sample-rate = 48000
#netjack2.period-size = 1024
#netjack2.encoding = float # float|opus
#netjack2.kbps = 64
#midi.ports = 0
#audio.channels = 2
#audio.position = [ FL FR ]
source.props = {
# extra sink properties
}
sink.props = {
# extra sink properties
}
}
}
]