Skip to main content

POST 
/startJackWithJacktripP2PClient

Starts a jack process on the machine, then, starts a Jacktrip P2P client.

Request​

Body

required

    jack

    object

    required

    device string

    This is the device name, if empty this defaults the default soundcard

    inputChannels number

    Default value: 2

    These are the numbers of input channels

    outputChannels number

    Default value: 2

    These are the numbers of output channels

    sampleRate number

    Default value: 48000

    The samplerate 22050 | 32000 | 44100 | 48000 | 88200 | 96000 | 192000

    bufferSize number

    Default value: 256

    The buffersize (frames/period) 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096

    periods number

    Default value: 2

    The periods/buffer

    killAllProcessesBeforeStart boolean

    Default value: true

    Kills all jack and jacktrip instances before startup

    jacktrip

    object

    required

    channels number

    Default value: 2

    Number of Input and output channels

    debug boolean

    Show debug information

    killAllJacktripBeforeStart boolean

    Kills all jacktrip instances before startup

    localPort number

    Default value: 4464

    The local port on which the Jacktrip instance is running

    connectDefaultAudioPorts boolean

    Default value: true

    Boolean if we need to make default audio connections

    queueBuffer number

    Default value: 4

    Queue Buffer Length, in packet size

    realtimePriority boolean

    Default value: true

    Enable realtime priority for networking threads

    bitRate number

    Default value: 16

    Audio Bit Rate Resolutions. Possible values are 8 | 16 | 24 | 32

    clientName string

    Default value: beeworker

    This is the name of the client (also the remote name)

    receiveChannels number

    Default value: 2

    Numbers of channels received from network

    redundancy number

    Default value: 1

    Packet Redundancy to avoid glitches with packet losses

    sendChannels number

    Default value: 2

    Numbers of channels sent to network

    host string

    Default value: localhost

    This is the ip address of the JackTrip server

    remotePort number

    Default value: 4464

    The remote port

Responses​

Schema

    message stringrequired

    A message with clear information what's going on.

    runningCommand string[]required

    The current running command on the host.

Loading...